File: make-klone-project.1

package info (click to toggle)
webserver-package 0.3
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, lenny, sid, squeeze, stretch, wheezy
  • size: 104 kB
  • ctags: 14
  • sloc: sh: 321; makefile: 27
file content (150 lines) | stat: -rw-r--r-- 3,772 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH MAKE-KLONE-PROJECT 1 "16 Sep 2007"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
make-klone-project \- manage a KLone based custom Debian package
.SH SYNOPSIS
.B make-klone-project
.RI [ options ]\  COMMAND
.SH DESCRIPTION
.B make-klone-project
is a tool to create and manage custom webserver packages that use
KLone, a framework that integrates a web site with possibly dynamic
content and a web server into a single binary.
.PP
The aim is to let the author to focus on editing the site specific
files under
.B webapp/
and allow creating a Debian package containing the web server and an
init.d script to manage it with
.nh
.BR dpkg-buildpackage .
.hy
.SH USAGE
.B make-klone-project
takes one non-option argument.
.TP
.B create
Create a new project directory,
.IR package \-0.1
and seeds it with KLone's source and a debian/ directory.
.TP
.B clean
Remove all non-user created files and directories ie. everything but
.nh
.IR debian/copyright ,
.IR debian/changelog ,
.I debian/wsp.*
and
.IR webapp/ .
.hy
See also the
.B \-l
option below.
.TP
.B refresh
Cleans the project directory as with
.nh
.B make-klone-project clean
.hy
and reseeds the KLone source and the debian/ directory.
.SH EXAMPLES
 make-klone-project create -p myapp -m "Kari Pahula <kaol@debian.org>"
 cd myapp-0.1
 (edit any files that require editing, mostly in webapp/)
 make-klone-project refresh
 dpkg-buildpackage -rfakeroot
 sudo dpkg -i ../myapp_0.1_i386.deb
.SH OPTIONS
.TP
\fB\-b \fINAME\fR
Name the created web server binary as
.IR NAME .
If not specified the package name is used.
.TP
.B -l
Look for the project root directory in
.nh
.B clean
and
.B refresh
.hy
commands by changing the working directory to the parent directory
until they find a file named
.nh
.I debian/wsp.opt.maintainer
.hy
in the current directory.  Returns with error if none is found.
Without this option, only the current directory is checked for this
file.

The upside of using this option is that
.nh
.B make-klone-project
.hy
will be agnostic about the working directory, as long as it is
somewhere inside the project tree, just like
.nh
.BR dpkg-buildpackage .
.hy
The downside is that you run a greater risk of having the
.B clean
command cause unwanted data loss, if you happen to have an
unfortunately named file in a wrong place.
.TP
\fB-m \fINAME\fR
Sets the maintainer name as
.IR NAME .
.TP
\fB-p \fINAME\fR
Set the package name as
.IR NAME .
Only effective with the
.B create
command.  If not specified, uses
.BR customkloneapp .
.SH FILES
.TP
.I debian/wsp.description
A custom description for the package.  Should be formatted like the
corresponding field in the
.I debian/control
file.
.TP
.I debian/wsp.opt.*
The options set in prior calls to
.BR make-klone-project .
.TP
.I webapp/
The user specified site tree, to be imported as the site by KLone.
.SH NOTES
Your web server will be run as a root, so you will need to use either
.B allow_root
or
.B uid
and
.B gid
options in your
.IR etc/kloned.conf .
.SH SEE ALSO
.BR dpkg-buildpackage (1),
.BR klone (1),
.BR kloned.conf (5),
.BR kloned (8).
.SH AUTHOR
.B make-klone-project
was written by Kari Pahula <kaol@debian.org>.