Permalink
Browse files

Updates manpages

git-svn-id: svn://cherokee-project.com/cherokee/trunk@6316 5dc97367-97f1-0310-9951-d761b3857238
  • Loading branch information...
taher
taher committed Feb 16, 2011
1 parent 81f48a1 commit b41e1595b4577e8512b267c85108d23a57cbe503
Showing with 26 additions and 18 deletions.
  1. +1 −1 cherokee-admin-launcher.1
  2. +10 −6 cherokee-admin.1
  3. +6 −2 cherokee-config.1
  4. +3 −3 cherokee-tweak.1
  5. +6 −6 cherokee.1
@@ -1,4 +1,4 @@
-.TH cherokee-admin-launcher 8 "December 13, 2010"
+.TH cherokee-admin-launcher 8 "February 16, 2011"
.SH NAME
cherokee-admin-launcher - Easy launcher for Cherokee's administrative interface
.SH SYNOPSIS
View
@@ -1,9 +1,9 @@
-.TH cherokee-admin 8 "September 20, 2010"
+.TH cherokee-admin 8 "February 16, 2011"
.SH NAME
cherokee-admin - Runs Cherokee's administrative interface
.SH SYNOPSIS
.B cherokee-admin
-[\-d DIR] [\-p PORT] [\-C FILE] [\-b] [\-x] [\-u] [\-t]
+[\-d<DIR>] [\-p<PORT>] [\-C<FILE>] [\-b] [\-x] [\-u] [\-t]
.SH DESCRIPTION
\fIcherokee-admin\fP runs the server for the administrative interface
used to configure Cherokee. The interface itself will be available via
@@ -27,17 +27,17 @@ to authenticate. This disables a security measure and is only meant to
ease the development process. The usage of this parameter is strongly
discouraged for regular users.
.TP 8
-.B \-b, --bind[=IP]
+.B \-b[<IP>], --bind[=<IP>]
By default \fIcherokee-admin\fP binds only to 127.0.0.1 (localhost), which
means you can only connect to it from the same system. With this parameter
you can specify the network address to listen to. If no IP is provided,
it will bind to all interfaces.
.TP 8
-.B \-d, --appdir=DIR
+.B \-d<DIR>, --appdir=<DIR>
Uses a custom admin-interface path where the source files of
\fIcherokee-admin\fP reside.
.TP 8
-.B \-p, --port=NUM
+.B \-p<NUM>, --port=<NUM>
Specifies an alternative port. By default, 9090.
.TP 8
.B \-t, --internal-unix
@@ -46,7 +46,11 @@ communications. This parameter specifies that a Unix domain socket
should be used instead. The default behavior is the safest one, so
this parameter should rarely by used.
.TP 8
-.B \-C, --target=PATH
+.B \-T<NUM>, --thread=<NUM>
+Specify the number of threads that the program should use. Useful for
+memory/power constrained machines.
+.TP 8
+.B \-C<PATH>, --target=PATH
Requests a configuration file different than the default
/etc/cherokee/cherokee.conf to be used
.SH SEE ALSO
View
@@ -1,9 +1,9 @@
-.TH CHEROKEE
+.TH cherokee-config 1 "February 16, 2011"
.SH NAME
cherokee-config - script to get information about the installed version of Cherokee
.SH SYNOPSIS
.B cherokee-config
-[\-\-prefix\fI[=DIR]\fP] [\-\-libs] [\-\-cflags] [\-\-version] [\-\-help]
+[\-\-prefix\fI=<DIR>\fP] [\-\-libs] [\-\-cflags] [\-\-version] [\-\-help]
.SH DESCRIPTION
\fIcherokee-config\fP is a tool that is used to determine the compile and
linker flags that should be used to compile and link programs that use
@@ -29,3 +29,7 @@ any \-\-libs or \-\-cflags options.
.SH AUTHOR
This manual page was written by Fredrik Hallenberg <hallon@lysator.liu.se>,
for the Debian GNU/linux system (but may be used by others).
+.SH SEE ALSO
+\&\fIcherokee-admin\fR\|(8)
+.PP
+This program is a part of the Cherokee web server, \&\fIcherokee\fR\|(1)
View
@@ -1,4 +1,4 @@
-.TH cherokee-tweak 1
+.TH cherokee-tweak 1 "February 16, 2011"
.SH NAME
cherokee-tweak - Command-line interface to the administration interface of Cherokee
.SH SYNOPSIS
@@ -59,10 +59,10 @@ Prints version and exits
.TP 8
\fIcherokee-tweak\fP accepts the following options:
.TP 8
-.B \-u, --user=STRING
+.B \-u<STRING>, --user=<STRING>
Specifies the user name with which to identify to the server
.TP 8
-.B \-p, --password=STRING
+.B \-p<STRING>, --password=<STRING>
Specifies the password with which to identify to the server
.SH SEE ALSO
\&\fIcherokee-admin\fR\|(8)
View
@@ -12,7 +12,7 @@
.\" along with this program; see the file COPYING. If not, write to
.\" the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
.\"
-.TH Cherokee 1 "December 13, 2010"
+.TH Cherokee 1 "February 16, 2011"
.\" Please update the above date whenever this man page is modified.
.\"
.\" Some roff macros, for reference:
@@ -50,14 +50,14 @@ Perform a sanity check on the configuration file. The server will not run.
Launches the server as a background process (default behaviour is to
stay attached to the controlling terminal).
.TP 8
-.B \-C, --config=PATH
+.B \-C<PATH>, --config=<PATH>
Specifies an alternative path for the configuration file to use instead
of the default cherokee.conf
.TP 8
-.B \-p, --port=PORT
+.B \-p<PORT>, --port=<PORT>
TCP port number to which the server will listen.
.TP 8
-.B \-r, --documentroot=PATH
+.B \-r<PATH>, --documentroot=<PATH>
Launches a server exposing statically the specified directory. When
launched with \-r, the configuration file is ignored, and the Cherokee
instance runs with its default values.
@@ -84,7 +84,7 @@ I would appreciate hearing of any problems you have with Cherokee. I
would also like to hear from you if you have successfully used Cherokee,
especially if you are using it for a distribution.
.PP
-Report bugs to
+Report bugs to
.B http://bugs.cherokee-project.com
.PP
There is a mailing list for discussion among Cherokee users and for
@@ -100,7 +100,7 @@ Cherokee can be run either with this command or
\&\fIcherokee-worker\fR\|(1). This last option is discouraged if you
are not developing though.
.
-Note that, for most systems, a startup/shutdown script such as
+Note that, for most systems, a startup/shutdown script such as
/etc/init.d/cherokee is provided and will probably be the most
convenient invocation method.
.SH AUTHOR

0 comments on commit b41e159

Please sign in to comment.