Mercurial Repository: p/roundup/code: roundup/scripts/roundup

comparison roundup/scripts/roundup_server.py @ 2483:55b496fb7b5b

better roundup-server usage string [SF#973352]

author	Richard Jones <richard@users.sourceforge.net>
date	Mon, 21 Jun 2004 04:42:11 +0000
parents	8f2d1aabd940
children	8822780fa519

comparison

equal deleted inserted replaced

-:8f2d1aabd940
+:55b496fb7b5b
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 #
 """Command-line script that runs a server over roundup.cgi.client.
-$Id: roundup_server.py,v 1.51 2004-06-21 04:33:52 richard Exp $
+$Id: roundup_server.py,v 1.52 2004-06-21 04:42:11 richard Exp $
 """
 __docformat__ = 'restructuredtext'
 # python version check
 from roundup import version_check
 break
 return rv
 def usage(message=''):
 if RoundupService:
-win = \
+os_part = \
-""''' -c: Windows Service options.  If you want to run the server as a Windows
+""''' -c <Command>  Windows Service options.
-Service, you must configure the rest of the options by changing the
+If you want to run the server as a Windows Service, you must
-constants of this program.  You will at least configure one tracker
+configure the rest of the options by changing the constants
-in the TRACKER_HOMES variable.  This option is mutually exclusive
+of this program.  You will at least configure one tracker in
-from the rest.  Typing "roundup-server -c help" shows Windows
+the TRACKER_HOMES variable.  This option is mutually exclusive
-Services specifics.'''
+from the rest.  Typing "roundup-server -c help" shows Windows
+Services specifics.'''
 else:
-win = ''
+os_part = ''' -u <UID>      runs the Roundup web server as this UID
+-g <GID>      runs the Roundup web server as this GID
+-d <PIDfile>  run the server in the background and write the server's PID
+to the file indicated by PIDfile. The -l option *must* be
+specified if -d is used.'''
 port=PORT
-print _('''%(message)s
+if message:
-Usage:
+message += '\n'
-roundup-server [options] [name=tracker home]*
+print _('''%(message)sUsage: roundup-server [options] [name=tracker home]*
-options:
+Options:
--v: print version and exit
+-v            prints the Roundup version number and exits
--n: sets the host name
+-n <name>     sets the host name of the Roundup web server instance
--p: sets the port to listen on (default: %(port)s)
+-p <port>     sets the port to listen on (default: %(port)s)
--u: sets the uid to this user after listening on the port
+-l <fname>    log to the file indicated by fname instead of stderr/stdout
--g: sets the gid to this group after listening on the port
+-N            log client machine names instead of IP addresses (much slower)
--l: sets a filename to log to (instead of stderr / stdout)
+%(os_part)s
--d: run the server in the background and on UN*X write the server's PID
-to the nominated file. The -l option *must* be specified if this
+Examples:
-option is.
+roundup-server support=/var/spool/roundup-trackers/support
--N: log client machine names in access log instead of IP addresses (much
-slower)
+roundup-server -d /var/run/roundup.pid -l /var/log/roundup.log \\
-%(win)s
+support=/var/spool/roundup-trackers/support
-name=tracker home:
+How to use "name=tracker home":
-Sets the tracker home(s) to use. The name is how the tracker is
+These arguments set the tracker home(s) to use. The name is how the
-identified in the URL (it's the first part of the URL path). The
+tracker is identified in the URL (it's the first part of the URL path).
-tracker home is the directory that was identified when you did
+The tracker home is the directory that was identified when you did
 "roundup-admin init". You may specify any number of these name=home
 pairs on the command-line. For convenience, you may edit the
 TRACKER_HOMES variable in the roundup-server file instead.
 Make sure the name part doesn't include any url-unsafe characters like
 spaces, as these confuse the cookie handling in browsers like IE.

Mercurial > p > roundup > code

comparison roundup/scripts/roundup_server.py @ 2483:55b496fb7b5b