Man pages update from Micah Anderson.
authorDaniel Hokka Zakrisson <daniel@hozac.com>
Sat, 27 Oct 2007 19:34:50 +0000 (19:34 +0000)
committerDaniel Hokka Zakrisson <daniel@hozac.com>
Sat, 27 Oct 2007 19:34:50 +0000 (19:34 +0000)
git-svn-id: http://svn.linux-vserver.org/svn/util-vserver/trunk@2631 94cd875c-1c1d-0410-91d2-eb244daf1a30

contrib/manifest.dat.pathsubst
man/Makefile-files
man/vserver-build.8.pathsubst [new file with mode: 0644]
man/vserver.8

index 3bb285c..961656f 100644 (file)
@@ -136,7 +136,7 @@ core   @MANDIR@/*/reducecap*
 legacy @MANDIR@/*/distrib-info*
 legacy @MANDIR@/*/vserver-copy*
 legacy @MANDIR@/*/rebootmgr*
-legacy @MANDIR@/*/vps.*
+base   @MANDIR@/*/vps.*
 base   @MANDIR@/*/vpstree.*
 base   @MANDIR@/*/vserver-stat*
 base   @MANDIR@/*/vserver.*
index d2216d3..5e3e4bc 100644 (file)
@@ -28,6 +28,13 @@ man_pages            =  man/chbind.8 \
                           man/vserver-stat.8 \
                           man/vserver.8 \
                           man/vtop.8
+man_susbt_SRCS =       man/vserver-build.8.pathsubst
+man_gen_DTA =          man/vserver-build.8
 
-man_MANS +=            $(man_pages)
-EXTRA_DIST +=          $(man_pages)
+man_MANS +=            $(man_pages) \
+                       $(man_gen_DTA)
+EXTRA_DIST +=          $(man_pages) \
+                       $(man_susbt_SRCS)
+CLEANFILES +=          $(man_gen_DTA)
+
+man/vserver-build.8:   man/.vserver-build.8.pathsubst.stamp
diff --git a/man/vserver-build.8.pathsubst b/man/vserver-build.8.pathsubst
new file mode 100644 (file)
index 0000000..e989d06
--- /dev/null
@@ -0,0 +1,173 @@
+.TH VSERVER-BUILD "8" "October 27, 2007" "vserver-build" "System Administration"
+.SH "NAME"
+vserver-build \- initializes a vserver
+.SH SYNTAX
+.B vserver-build
+\fB\-m\fR \fImethod\fR \fB\-n\fR \fIname\fR [\fB\-\-force\fR] [\fB\-\-keep\fR]
+[\fB\-\-rootdir\fR \fIdir\fR] [\fB\-\-pkgbase\fR \fIdir\fR]
+\fIconfig options*\fR [\fB\-\-\fR] \fImethod arguments*\fR
+.TP
+\fB\-m\fR \fImethod\fR
+Use build \fImethod\fR; see below for possible values.
+.TP
+\fB\-n\fR \fIname\fR
+Name of vserver you are building.
+.TP
+\fB\-\-force\fR 
+Remove/rename already existing vservers with the same name.
+.TP
+\fB\-\-keep\fR 
+Do not delete generated files and directories if vserver build fails.
+.TP
+\fB\-\-rootdir\fR \fIdir\fR
+Root vserver directory [default: @SYSCONFDIR@/vservers/.defaults/vdirbase].
+.TP
+\fB\-\-pkgbase\fR \fIdir\fR
+Package base directory [default: @VSERVERDIR@/.pkg].
+.SH "CONFIG OPTIONS"
+.TP
+\fB\-\-context\fR \fInum\fR
+.IP
+\&The static context of the vserver [default: none; one will be generated for you].
+The valid range is 2 through 49151.
+.TP
+\fB\-\-confdir\fR \fIdir\fR
+.IP
+\&The vserver configuration directory to use [default: @SYSCONFDIR@/vservers/<name>].
+.TP
+\fB\-\-lockfile\fR \fIfilename\fR
+.IP
+\&The lockfile to use [default: /var/run/vservers/<name>].
+.TP
+\fB\-\-hostname\fR \fIhostname\fR
+.IP
+\&Hostname of the vserver.
+.TP
+\fB\-\-netdev\fR \fIdevice\fR
+.IP
+\&The default interface to use for \fB--interface\fR.
+.TP
+\fB\-\-netbcast\fR \fIbroadcast\fR
+.IP
+\&Broadcast address to associate with the vserver.
+.TP
+\fB\-\-netmask\fR \fInetmask\fR|\fB\-\-netprefix\fR \fIprefixlen\fR
+.IP
+\&Sets the default netmask (a.b.c.d quadruple) or prefixlen (length of the
+network).
+.TP
+\fB\-\-interface\fR [\fIname\-suffix\fR=][\fIdevice\fR:]\fIip\fR[/\fImask|prefixlen\fR]
+.IP
+\&Declares a network\-interface name and associated IP/netmask; this option can
+be specified multiple times.
+.TP
+\fB\-\-flags\fR \fIflags+\fR
+.IP
+\&Sets comma\-separated list of flags; see lib/cflags-v13.c for a list.
+.TP
+\fB\-\-cpuset\fR \fIname\fR
+.IP
+\&Declares the CPUSET this vserver will run in [default: none]
+.TP
+\fB\-\-cpusetcpus\fR \fInumber[\-number][:exclusive]\fR
+.IP
+\&Sets which CPUs belong to the CPUSET, \fI:exclusive\fR is a flag (0|1)
+prohibiting any other cpuset from using those CPUs.
+.TP
+\fB\-\-cpusetmems\fR \fInumber[\-number][:exclusive]\fR
+.IP
+\&Sets which memory pools belong to the CPUSET, \fI:exclusive\fR is a flag
+(0|1) prohibiting any other cpuset from using those memory pools.
+.TP
+\fB\-\-cpusetvirt\fR
+.IP
+\&Virtualize the cpuset (the vserver will see only CPUs defined in the cpuset).
+Requires kernel patch from http://www.bullopensource.org/cpuset/
+.TP
+\fB\-\-initstyle\fR \fIstyle\fR
+.IP
+\&Configures the initstyle (e.g. minit, sysv, plain, gentoo)
+.SH "METHODS"
+.TP
+\fBapt\-rpm\fR
+.IP
+\& \fB\-\-\fR \fB\-d\fR \fIdistribution\fR
+
+\&Installs the base\-packages of the given distribution with the help of
+'\fBvapt\-get\fR'
+.TP
+\fByum\fR
+.IP
+\&\fB\-\-\fR \fB\-d\fR \fIdistribution\fR
+
+\&Installs the base\-packages of the given distribution with help of
+'\fBvyum\fR'
+.TP
+\fBrpm\fR
+.IP
+\&\fB\-\-\fR [\fB\-d\fR \fIdistribution\fR] \fB\-\-empty\fR|([\fB\-\-force\fR] [\fB\-\-nodeps\fR] \fImanifest\fR)+
+
+\&Installs lists of rpm\-packages
+.TP
+\fBskeleton\fR
+.IP
+\&\fB\-\-\fR [\fIcmd args*\fR]
+
+\&Installs a minimal skeleton filesystem, creates the configuration file
+and calls an optional command
+.TP
+\fBdebootstrap\fR
+.IP
+\fB\-\-\fR \fB\-d\fR \fIdistribution\fR [\fB\-m\fR \fImirror\fR] [\fB\-s\fR \fIscript\fR] [\fB\-\-\fR \fIdebootstrap\-options*\fR]
+
+\&Bootstraps the vserver with Debian's 'debootstrap' package
+.TP
+\fBtemplate\fR
+.IP
+\&\fB\-\-\fR (\fB\-t\fR \fItarball\fR)+ [\fB\-d\fR \fIdistribution\fR]
+
+\&Installs a vserver using tarball(s)
+.TP
+\fBfai\fR
+.IP
+\&\fB\-\-\fR [\fB\-f\fR \fIfai_vserver\fR] [\fB\-n\fR \fInfsroot\fR] [\fB\-d\fR \fIfai_dir\fR] [\fB\-a\fR]
+
+\&Bootstraps the vserver with the Debian Fully Automatic Installation
+
+\fB\-f\fR means use the nfsroot and profile in the vserver \fIfai_vserver\fR
+
+\fB\-n\fR \fInfsroot\fR specifies the 'NFS' root explicitly
+
+\fB\-d\fR \fIfai_dir\fR specifies the location of the FAI profile
+
+the \fB\-f\fR option implies \fB\-n\fR and \fB\-d\fR are relative to the \fIfai_vserver\fR
+.TP
+\fBrsync\fR
+.IP
+\&\fB\-\-\fR [\fB\-d\fR \fIdistribution\fR] \fB\-\-source\fR \fIsource\fR [\fB\-o\fR \fIrsync option\fR]*
+
+\&Installs a vserver by rsyncing from \fIsource\fR to the guest root
+.TP
+\fBclone\fR
+.IP
+\&\fB\-\-\fR [\fB\-d\fR \fIdistribution\fR] \fB\-\-source\fR \fIsource\fR
+
+\&Clones a vserver by linking unified files and copying the rest
+.SH "EXAMPLES"
+.LP
+# vserver kea build -m debootstrap --context 10 --hostname kea --interface eth0:192.168.0.44/32 -- -d etch
+.SH "BUGS"
+.LP
+Please report bugs to vserver@list.linux\-vserver.org
+.SH "AUTHORS"
+.LP
+This man page was written by Micah Anderson <micah@debian.org> and based upon the helpful output from the program itself.
+.SH "SEE ALSO"
+.PP
+ chbind(8) chcontext(8)
+ rebootmgr(8) reducecap(8)
+ vps(8) vpstree(8)
+ vrpm(8)
+ vserver\-stat(8)
+ vtop(8)
+
index 6ea2052..c1c6702 100644 (file)
-.TH "vserver" "8" "0.1.0" "Klavs Klavsen <kl@vsen.dk>" "System Administration"
+.TH VSERVER 8 "October 24, 2007" "util-vserver" "System Administration"
 .SH "NAME"
 .LP 
-vserver \- The vserver utility enables you to control different aspects of your vservers.
-.SH "SYNTAX"
-.LP 
-vserver [ options ] [vserver name] [options]
-
-.SH "DESCRIPTION"
-.LP 
-vserver \- The vserver utility enables you to control different aspects of your vservers, such as stopping and starting them, and services within them.
-.SH "OPTIONS"
-.LP 
-.TP 
-\fBbuild\fR Create a virtual server by copying the packages of the root server
-.TP 
-\fBenter\fR Enter in the virtual server context and starts a shell. Same as "vserver name exec /bin/sh\".
-.TP 
-\fBexec\fR Exec a command in the virtual server context as root.
-syntax: vserver name exec command ...
-.TP 
-\fBsuexec\fR Exec a command in the virtual server context under some user id.
-syntax: vserver name suexec userid command ...
-.TP 
-\fBservice\fR Control a service inside a vserver. 
-syntax: vserver name service service\-name (start/stop/restart etc.)
-.TP 
-\fBstart\fR Starts the various services in the vserver.
-It uses the default runlevel found in the
-.B /etc/inittab
-file of the vserver.
-.TP 
-\fBstop\fR Ends all services and kills the remaining processes.
-.TP 
-\fBrunning\fR Tells if a virtual server is running. It returns proper exit code, so you can use it as a test.
-.TP
-\fBstatus\fR Tells various information about the state of a virtual server:
-running status, number of running processes and uptime.
-.TP
-.I --nodev
-do not configure the IP devices associated with the vserver. This
-is useful to execute some commands on the vserver (or enter it)
-without making it active on the network. Especially useful if you
-have an active copy of the vserver moved to another server on the
-network.
-.TP
-.I --silent
-cuts most informative messages.
-
+vserver \- The vserver utility enables you to manage the state of vservers, including building, starting, stopping, etc.
+.SH SYNTAX
+.B vserver
+[\fB-s|--sync\fR] [\fB-v|--verbose\fR] [\fB--silent\fR] [\-\-] \fIvserver\fR \fIcommand\fR [\fB--help\fR] \fIargs*\fR
+.TP
+\fB\-\-sync\fR - Perform synchronization with vshelper to ensure that the guest has been stopped
+.TP
+\fB\-\-verbose\fR - Makes things a lot louder.
+.TP
+\fB\-\-silent\fR - Removes most informative messages.
+.TP
+\fIvserver\fR - The name of a vserver.
+.TP
+\fIcommand\fR - One of the commands listed below.
+.TP
+\fB\-\-help\fR 
+.IP
+provides additional help for provided \fIcommand\fR, for example: vserver - build --help
+\fIargs\fR are the arguments that are possible for the different commands, see the
+arguments for each \fIcommand\fR listed below
+.SH "COMMANDS"
+.TP
+\fBstart\fR [\fB\-\-rescue\fR [\fB\-\-rescue\-init\fR] \fIprogram args\fR] 
+.IP
+\&Starts the specified vserver. The optional argument \fB--rescue\fR starts the
+vserver in rescue mode, which runs \fIprogram args*\fR to start the vserver
+instead of whatever is configured. The optional argument \fB--rescue-init\fR
+makes the command appear as PID 1 in the vserver. This can be used to start
+/bin/bash to investigate why a vserver is not able to start correctly.
+.TP
+\fBstop\fR [\fB\-\-rescue\-init\fR]
+.IP
+\&Stops the specified vserver, and kills the remaining processes. The optional
+argument \fB--rescue-init\fR can be used to stop a vserver that was started
+with the option of the same name.
+.TP
+\fBrestart\fR
+.IP
+\&Restarts the specified vserver. This is the subsequent execution of a
+synchronized 'stop' and a 'start'.
+.TP
+\fBcondrestart\fR
+.IP
+\&Restarts a running vserver.
+.TP
+\fBsuexec\fR \fIuser\fR \fIprogram args*\fR
+.IP
+\&Executes \fIprogram args*\fR as the specified \fIuser\fR in the vserver.
+.TP
+\fBexec\fR \fIprogram args*\fR
+.IP
+\&Executes \fIprogram args*\fR as the root user in the vserver.
+.TP
+\fBenter\fR
+.IP
+\&Executes the configured shell (default: /bin/bash if it exists) in the
+vserver and allocates a pty.
+.TP
+\fBchkconfig\fR \fIchkconfig\-options*\fR
+.IP
+\&Modifies the init\-system; currently, only Red Hat's \fBchkconfig\fR is
+supported.
+.TP
+\fBrunning\fR
+.IP
+\&Returns an exit code of 0 iff the vserver is running, 1 if not.
+.TP
+\fBstatus\fR
+.IP
+\&Provides some human readable status information about the vserver, and
+succeeds iff the vserver is running.
+.TP
+\fBbuild\fR \fIbuildopts*\fR
+.IP
+\&Create a vserver from scratch, where the \fIbuildopts*\fR are a set of
+options and a build method. As this option calls vserver-build, please see
+vserver-build(8) for a complete listing of possible options and methods.
+.TP
+\fBdelete\fR
+.IP
+\&Remove a vserver.
+.TP
+\fBunify\fR [\fB\-R\fR] [\fIvunify\-opts*\fR]
+.IP
+\&Unify or de-unify the vserver with its reference vserver(s).
+.TP
+\fBpkg install\fR \fIpkg*\fR
+.IP
+\&Installs package(s) \fIpkg\fR in the vserver.
+.TP
+\fBapt\-get,apt\-config,apt\-cache\fR \fIapt\-opts*\fR
+.IP
+\&Execute the apt\-* command for the given vserver
+.TP
+\fBrpm\fR \fIrpm\-opts*\fR
+.IP
+\&Execute the \fBrpm\fR command for the given vserver.
+.TP
+\fBpkgmgmt\fR \fBexternalize\fR|\fBinternalize\fR [\fB\-y\fR]
+.IP
+\&Externalize or internalize the package\-management for the given vserver.
+\'Externalize' means that package metadata and management tools (apt\-get,rpm)
+are living in the host, while 'internalize' means that data and programs from
+the vserver will be used.
+.TP
+\fBhashify\fR
+.IP
+\&Hashify the vserver.
 .SH "FILES"
 .LP 
 \fI/usr/sbin/vserver\fP 
 .P
-\fI/etc/vservers/*.conf\fP 
+\fI/etc/vservers/*\fP 
 .P
-\fI/etc/vservers/*.sh\fP 
 .P
-\fI/vservers/*\fP 
-
+\fI/var/lib/vservers/*\fP 
 .SH "EXAMPLES"
 .LP 
 Please contribute some, if you feel it's important.
 .SH "AUTHORS"
 .LP 
-This Man page was written by Klavs Klavsen <kl@vsen.dk> and based upon the helpful output from the program itself and the documentation on the Virtual Server site <http://www.solucorp.qc.ca/miscprj/s_context.hc?prjstate=1&nodoc=0>
+This man page was written by Micah Anderson <micah@debian.org> and based upon the helpful output from the program itself.
 .SH "SEE ALSO"
 .LP 
 chbind(8) chcontext(8)
-newvserver(8)
 rebootmgr(8) reducecap(8)
 vps(8) vpstree(8)
 vrpm(8)
+vserver\-build(8)
 vserver\-stat(8) 
 vtop(8)