[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Monotone-commits-diffs] net.venge.monotone.contrib.usher: 949e1ca70112
|
From: |
code |
|
Subject: |
[Monotone-commits-diffs] net.venge.monotone.contrib.usher: 949e1ca70112d6b6f2f7edd97d91990e5d02dbb0 |
|
Date: |
Wed, 19 Jan 2011 14:41:10 GMT |
revision: 949e1ca70112d6b6f2f7edd97d91990e5d02dbb0
date: 2011-01-19T14:40:28
author: Richard Levitte <address@hidden>
branch: net.venge.monotone.contrib.usher
changelog:
usherctl utility documented as a manpage instead of HTML.
A HTML version can be created like this:
groff -man -Thtml usherctl.1 > usherctl.html
manifest:
format_version "1"
new_manifest [3b764f47074b9546a26d3be530c5ae2f3ec237c0]
old_revision [e7277c425674dd747b3f4b809c56af2f488971c4]
delete "doc/usherctl.html"
add_file "doc/usherctl.1"
content [393f7651b857ae243a7507442f7f587146b73809]
patch "Makefile.am"
from [94c4c58400d00483bccf9c79a7f3f606d187db05]
to [1c5914da11c279b30a4185cc0fbe150d978e4a67]
============================================================
--- Makefile.am 94c4c58400d00483bccf9c79a7f3f606d187db05
+++ Makefile.am 1c5914da11c279b30a4185cc0fbe150d978e4a67
@@ -1,6 +1,5 @@ bin_PROGRAMS = usher
bin_PROGRAMS = usher
-dist_bin_SCRIPTS = utils/usherctl
usher_SOURCES = src/administrator.cc src/administrator.hh \
src/basic_io_serverlist_reader.cc \
@@ -18,9 +17,12 @@ usher_CPPFLAGS = -Wall -pedantic -Wextra
usher_CPPFLAGS = -Wall -pedantic -Wextra
+dist_bin_SCRIPTS = utils/usherctl
+dist_man1_MANS = doc/usherctl.1
+
TESTS=test/run-tests.sh
-EXTRA_DIST = test doc
+EXTRA_DIST = test $(wildcard $(srcdir)/doc/*.html)
mostlyclean-local:
rm -rf test-dir
============================================================
--- doc/usherctl.html fffd09c2ad2cb1724f7f602d5a9910c49fc896fa
+++ /dev/null
@@ -1,147 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
- <head>
- <meta http-equiv="content-type" content="text/html; charset=UTF-8">
- <title>Usherctl Documentation</title>
- </head>
-
- <body>
- <h1>Synopsis</h1>
-
- <p><tt>usherctl [ -c <i>configfile</i> ] <i>command</i>
- [ <i>commandoptions</i> ... ] [ <i>subcommand</i> ]
- [ <i>args</i> ... ]</tt></p>
-
- <h1>Description</h1>
-
- <p><tt>usherctl</tt> is a program to control usher and manipulate
- its configuration, as well as creating and removing entire
- projects, through a simple command set.</p>
-
- <p><tt>usherctl</tt> can be used to control the system usher
- daemon, or a private daemon. The difference is that when
- controling the system usher daemon, it will make sure that
- everything is owned by the daemon user. This, as well as other
- aspects of <tt>usherctl</tt>, is controlled with the
- configuration file, either the default one or the one given with
- <tt>-c</tt>.</p>
-
- <p><tt>usherctl</tt> keeps track of two directory trees, one for
- the configuration of usher, the other for the configuration and
- data of the projects created. They are refered to as "the usher
- configuration" and "the project configuration".</p>
-
- <h1>Commands</h1>
-
- <dl>
- <dt><tt>init</tt></dt>
- <dd>This will simply initialise the usher configuration.</dd>
- <dt><tt>rebuild</tt></dt>
- <dd>This will rebuild the usher configuration from the global
- configuration file and the configuration files for each
- project. This should be run at any time when the
- configuration has been changed manually.</dd>
- <dt><tt>add <i>name</i>
- [ -h <i>hostprefix</i> ] [ -p <i>patternprefix</i> ]
- <i>type</i> <i>args ..</i></tt></dt>
- <dd>This adds a usher server named <tt><i>name</i></tt>, with a
- possible host prefix or branch prefix, either of the
- <tt>local</tt> or <tt>remote</tt> type. The rest of the
- arguments are according to the type, please read the
- <a href="">usher documentation</a> for
- further information on these.</dd>
- <dt><tt>mod <i>name</i>
- [ -h <i>hostprefix</i> ] [ -p <i>patternprefix</i> ]
- <i>type</i> <i>args ..</i></tt></dt>
- <dd>Like <tt>add</tt>, but modifies an already existing usher
- server instead of adding it.</dd>
- <dt><tt>del <i>name</i></tt></dt>
- <dd>Removes the usher server <tt><i>name</i></tt></dd>
- <dt><tt>mkpubproject <i>name</i></tt></dt>
- <dd>Creates a project set up so anyone can read from it,
- anonymously. This also creates the usher server
- <tt><i>name</i></tt>, of type <tt>local</tt>.</dd>
- <dt><tt>mkprivproject <i>name</i></tt></dt>
- <dd>Creates a project set up so only registered key owners can
- read from it. This also creates the usher server
- <tt><i>name</i></tt>, of type <tt>local</tt>.</dd>
- <dt><tt>rmproject <i>name</i></tt></dt>
- <dd>Removes the project <tt><i>name</i></tt>. This destroys
- everything associated with that project, including the usher
- server and server database.</dd>
- <dt><tt>start</tt></dt>
- <dd>Starts the usher daemon if it's not already started.</dd>
- <dt><tt>stop</tt></dt>
- <dd>Stops the usher daemon if it's started.</dd>
- <dt><tt>restart</tt></dt>
- <dd>Restarts a running usher daemon.</dd>
- <dt><tt>reload</tt></dt>
- <dd>Has the usher daemon reload its configuration.</dd>
- <dt><tt>status</tt></dt>
- <dd>Checks if the usher daemon is up or not.</dd>
- <dt><tt>list</tt></dt>
- <dd>Lists the configured usher servers, and says if they are a
- project controlled by <tt>usherctl</tt>.</dd>
- </dl>
-
- <h1>Configuration</h1>
-
- <p>Configuration is done with simple shell variable assignments
- in a configuration file. The variables to be used are:</p>
-
- <dl>
- <dt><tt>USHER</tt></dt>
- <dd>Usher binary.<br />
- (default: /usr/bin/usher)</dd>
- <dt><tt>MTN</tt></dt>
- <dd>Monotone binary.<br />
- (default: /usr/bin/mtn)</dd>
- <dt><tt>USHER_CONFDIR</tt></dt>
- <dd>Configuration directory.<br />
- (default: /etc/usher)</dd>
- <dt><tt>USHER_CONF</tt></dt>
- <dd>Actual configuration file.<br />
- (default: $USHER_CONFDIR/usher.conf)</dd>
- <dt><tt>USHER_GLOBALCONF</tt></dt>
- <dd>Global configuration template.<br />
- (default: $USHER_CONFDIR/global.conf)</dd>
- <dt><tt>USHER_CONFD</tt></dt>
- <dd>Directory for project specific configuration files.<br />
- (default: $USHER_CONFDIR/conf.d)</dd>
- <dt><tt>USHER_PIDFILE</tt></dt>
- <dd>Usher PID file.<br />
- (default: /var/run/usher.pid)</dd>
- <dt><tt>USHER_LOGDIR</tt></dt>
- <dd>Usher log directory.<br />
- (default: /var/log/usher)</dd>
- <dt><tt>USHER_PROJECTDIR</tt></dt>
- <dd>Usher projects directory.<br />
- (default: /var/lib/usher/projects)</dd>
- </dl>
-
- <p>The following variables are only useful for the system
- administrator that wants to set up a system wide usher:</p>
-
- <dl>
- <dt><tt>USHER_SYSTEM_STARTUP</tt></dt>
- <dd>a non-empty string if usher should be started and stopped with the
- script /etc/init.d/usher.<br />
- (default: (unset))</dd>
- <dt><tt>USHER_USER</tt></dt>
- <dd>User to run usher as. Only useful if usher is started with
- /etc/init.d/usher.<br />
- MUST match the user usher is started as!</dd>
- <dt><tt>USHER_GROUP</tt></dt>
- <dd>Group to run usher as. Only useful if usher is started with
- /etc/init.d/usher.<br />
- MUST match the group usher is started as!</dd>
- </dl>
-
- <hr>
- <address><a href="">Richard Levitte</a></address>
-<!-- Created: Wed Dec 1 09:50:50 CET 2010 -->
-<!-- hhmts start -->
-Last modified: Tue Jan 18 13:00:06 CET 2011
-<!-- hhmts end -->
- </body>
-</html>
============================================================
--- /dev/null
+++ doc/usherctl.1 393f7651b857ae243a7507442f7f587146b73809
@@ -0,0 +1,268 @@
+.\" Man page formatted with recommendations from
+.\" http://www.schweikhardt.net/man_page_howto.html
+.\"
+.\" However, font usage is a bit lacking, so I took inspiration from
+.\" http://fog.ccsf.cc.ca.us/~gboyd/cs260a/online/man/page_format.html
+.\"
+.\" Font usage:
+.\" commands, keywords, option markers: bold (\fB or .B)
+.\" arguments and other input: italic (\fI or .I)
+.\" optional markers ([, ], ...): regular (\fP)
+.\" verbatim text (examples and output): courier (\fC)
+.\"
+.TH "USHERCTL" 1 "2011-01-18" "usher 1.0~dev" "Monotone program suite"
+.SH "NAME"
+usherctl - project and process control for usher
+.SH "SYNOPSIS"
+.B usherctl
+[
+.B \-c
+.I configfile
+]
+.I command
+[
+.I name
+] [
+.IR option ...
+] [
+.IR arg ...
+]
+.SH "WARNING"
+This manpage is not well\(hymaintained; it is crafted from the HTML
+document that comes with
+.BR usher ,
+and probably contains inaccuracies. For the complete, accurate
+manual, including tutorial, concepts, and full reference
+documentation, please refer to
+'nh
+.BR /usr/share/doc/usher/doc/usherctl.html .
+'hy 1
+The developers will gratefully accept patches to arrange that this
+manpage and the main manual are kept in sync mechanically.
+.SH "DESCRIPTION"
+.B usherctl
+is a program to control
+.B usher
+and manipulate its configuration, as well as creating and removing
+entire projects, through a simple command set.
+.PP
+.B usherctl
+can be used to control the system
+.B usher
+daemon, or a private daemon. The difference is that when controling
+the system
+.B usher
+daemon, it will make sure that everything is owned by the daemon user.
+This, as well as other aspects of
+.BR usherctl ,
+is controlled with the configuration file, either the default one or
+the one given with
+.BR -c .
+Unless you're administrating a central usher server, chances are you
+want to use something other than the default.
+.PP
+.B usherctl
+keeps track of two directory trees, one for the configuration of
+.BR usher ,
+the other for the configuration and data of the projects created.
+They are refered to as "the usher configuration" and "the project
+configuration".
+.SH COMMANDS
+.TP
+\fBinit\fP [ \fB-a\P \fIadminaddr\fP ] [ \fB-l\P \fIlistenaddr\fP ] [ \fB-u\P \fIadminuser\fP ] [ \fB-p\P \fIadminpass\fP ]
+This will simply initialise the usher configuration. It creates the
+global infrastructure, including the global configuration file (if one
+doesn't already exist) and the skeleton scripts.
+.TP
+\fBrebuild\fP
+This will rebuild the usher configuration from the global
+configuration file and the configuration files for each project and
+reinstall the skeleton scripts. This should be run at any time when
+the configuration has been changed manually or when usherctl has been
+upgraded.
+.TP
+\fBadd\fP \fIname\fP [ \fB\-h\fP \fIhostprefix\fP ] [ \fB\-p\fP \fIpatternprefix\fP ] \fItype\fP \fIargs\fP ...
+This adds a usher server named
+.IR name ,
+with a possible host prefix or branch prefix, either of the
+.B local
+or
+.B remote
+type. The rest of the arguments are according to the type, please see
+.BR usher.conf (5)
+for further information on these.
+.TP
+\fBmod\fP \fIname\fP [ \fB\-h\fP \fIhostprefix\fP ] [ \fB\-p\fP \fIpatternprefix\fP ] \fItype\fP \fIargs\fP ...
+Like
+.BR add ,
+but modifies an already existing usher server instead of adding it.
+.TP
+\fBdel\fP \fIname\fP
+Removes the usher server
+.IR name .
+.TP
+\fBmkpubproject\fP \fIname\fP
+Creates a project set up so anyone can read from it, anonymously.
+This also creates the usher server
+.IR name ,
+of type
+.BR local .
+.TP
+\fBmkprivproject\fP \fIname\fP
+Creates a project set up so only registered key owners can read from
+it. This also creates the usher server
+.IR name ,
+of type
+.BR local .
+.TP
+\fBrmproject\fP \fIname\fP
+Removes the project
+.IR name .
+This destroys everything associated with that project, including the
+usher server and server database.
+.TP
+\fBaddkey\fP \fIname\fP [ \fB-t\fP \fItype\fP ]
+Adds a public monotone key to the public key store in the public key
+store for the project
+.IR name .
+The public key itself is expected to come on standard input.
+.RS
+.PP
+The different key types are:
+.IP \fBro\fP
+for read-only keys. The user using this key will only be able to pull
+from the project's database but not push. Typically used with private
+projects.
+.IP \fBrw\fP
+for read-write keys. The user using this key will be able to pull
+from the project's database as well as push to it.
+.IP \fBra\fP
+for keys that are given access to the \fCmtn automate remote\fP
+interface. Use with caution! In public projects, this is only needed
+for commands that puts something in the project's database, read-only
+commands can be reached anonymously.
+.RE
+.TP
+\fBaddpattern\fP \fIname\fP \fIpattern\fB
+Adds a branch pattern
+.I pattern
+to the project
+.IR name .
+This is used to create a limited set of acceptable branches. When
+no pattern has been defined yet, the default pattern is
+.BR * .
+.TP
+\fBstart\fP
+Starts the
+.B usher
+daemon if it's not already started.
+.TP
+\fBstop\fP
+Stops the
+.B usher
+daemon if it's started.
+.TP
+\fBrestart\fP
+Restarts a running
+.B usher
+daemon.
+.TP
+\fBreload\fP
+Has the
+.B usher
+daemon reload its configuration.
+.TP
+\fBstatus\fP
+Checks if the
+.B usher
+daemon is up or not.
+.TP
+\fBlist\fP
+Lists the configured usher servers, and says if they are a project
+controlled by
+.BR usherctl.
+.SH CONFIGURATION
+Configuration is done with simple shell variable assignments in a
+configuration file. The variables to be used are:
+.TP
+\fBUSHER\fP
+Usher binary.
+.IP
+(default: \fC/usr/bin/usher\fP)
+.TP
+\fBMTN\fP
+Monotone binary.
+.IP
+(default: \fC/usr/bin/mtn\fP)
+.TP
+\fBUSHER_CONFDIR\fP
+Configuration directory.
+.IP
+(default: \fC/etc/usher\fP)
+.TP
+\fBUSHER_CONF\fP
+Actual configuration file.
+.IP
+(default: \fC$USHER_CONFDIR/usher.conf\fP)
+.TP
+\fBUSHER_GLOBALCONF\fP
+Global configuration template.
+.IP
+(default: \fC$USHER_CONFDIR/global.conf\fP)
+.TP
+\fBUSHER_CONFD\fP
+Directory for project specific configuration files.
+.IP
+(default: \fC$USHER_CONFDIR/conf.d\fP)
+.TP
+\fBUSHER_SKEL\fP
+Directory for skeleton files that are copied to new projects.
+.IP
+(default: \fC$USHER_CONFDIR/skel\fP)
+.TP
+\fBUSHER_PIDFILE\fP
+Usher PID file.
+.IP
+(default: \fC/var/run/usher.pid\fP)
+.TP
+\fBUSHER_LOGDIR\fP
+Usher log directory.
+.IP
+(default: \fC/var/log/usher\fP)
+.TP
+\fBUSHER_PROJECTDIR\fP
+Usher projects directory.
+.IP
+(default: \fC/var/lib/usher/projects\fP)
+.PP
+The following variables are only useful for the system administrator
+that wants to set up a system wide usher:
+.TP
+\fBUSHER_SYSTEM_STARTUP\fP
+a non-empty string if
+.B usher
+should be started and stopped with the script
+\fC/etc/init.d/usher\fP.
+.IP
+(default: \fI(unset)\fP)
+.TP
+\fBUSHER_USER\fP
+User to run
+.B usher
+as. Only useful if
+.B usher
+is started with \fC/etc/init.d/usher\fP.
+.IP
+MUST match the user usher is started as!
+.TP
+\fBUSHER_GROUP\fP
+Group to run
+.B usher
+as. Only useful if
+.B usher
+is started with \fC/etc/init.d/usher\fP.
+.IP
+MUST match the group usher is started as!
+.SH "AUTHOR"
+.nf
+Richard Levitte <address@hidden>
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Monotone-commits-diffs] net.venge.monotone.contrib.usher: 949e1ca70112d6b6f2f7edd97d91990e5d02dbb0,
code <=