Changeset 2631

Show
Ignore:
Timestamp:
10/27/07 21:34:50 (1 year ago)
Author:
dhozac
Message:

Man pages update from Micah Anderson.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/contrib/manifest.dat.pathsubst

    r2625 r2631  
    137137legacy @MANDIR@/*/vserver-copy* 
    138138legacy @MANDIR@/*/rebootmgr* 
    139 legacy @MANDIR@/*/vps.* 
     139base  @MANDIR@/*/vps.* 
    140140base   @MANDIR@/*/vpstree.* 
    141141base   @MANDIR@/*/vserver-stat* 
  • trunk/man/Makefile-files

    r1192 r2631  
    2929                           man/vserver.8 \ 
    3030                           man/vtop.8 
     31man_susbt_SRCS =        man/vserver-build.8.pathsubst 
     32man_gen_DTA =           man/vserver-build.8 
    3133 
    32 man_MANS +=             $(man_pages) 
    33 EXTRA_DIST +=           $(man_pages) 
     34man_MANS +=             $(man_pages) \ 
     35                        $(man_gen_DTA) 
     36EXTRA_DIST +=           $(man_pages) \ 
     37                        $(man_susbt_SRCS) 
     38CLEANFILES +=           $(man_gen_DTA) 
     39 
     40man/vserver-build.8:    man/.vserver-build.8.pathsubst.stamp 
  • trunk/man/vserver.8

    r2 r2631  
    1 .TH "vserver" "8" "0.1.0" "Klavs Klavsen <kl@vsen.dk>" "System Administration" 
     1.TH VSERVER 8 "October 24, 2007" "util-vserver" "System Administration" 
    22.SH "NAME" 
    33.LP  
    4 vserver \- The vserver utility enables you to control different aspects of your vservers. 
    5 .SH "SYNTAX" 
    6 .LP  
    7 vserver [ options ] [vserver name] [options] 
    8  
    9 .SH "DESCRIPTION" 
    10 .LP  
    11 vserver \- The vserver utility enables you to control different aspects of your vservers, such as stopping and starting them, and services within them. 
    12 .SH "OPTIONS" 
    13 .LP  
    14 .TP  
    15 \fBbuild\fR Create a virtual server by copying the packages of the root server 
    16 .TP  
    17 \fBenter\fR Enter in the virtual server context and starts a shell. Same as "vserver name exec /bin/sh\". 
    18 .TP  
    19 \fBexec\fR Exec a command in the virtual server context as root. 
    20 syntax: vserver name exec command ... 
    21 .TP  
    22 \fBsuexec\fR Exec a command in the virtual server context under some user id. 
    23 syntax: vserver name suexec userid command ... 
    24 .TP  
    25 \fBservice\fR Control a service inside a vserver.  
    26 syntax: vserver name service service\-name (start/stop/restart etc.) 
    27 .TP  
    28 \fBstart\fR Starts the various services in the vserver. 
    29 It uses the default runlevel found in the 
    30 .B /etc/inittab 
    31 file of the vserver. 
    32 .TP  
    33 \fBstop\fR Ends all services and kills the remaining processes. 
    34 .TP  
    35 \fBrunning\fR Tells if a virtual server is running. It returns proper exit code, so you can use it as a test. 
     4vserver \- The vserver utility enables you to manage the state of vservers, including building, starting, stopping, etc. 
     5.SH SYNTAX 
     6.B vserver 
     7[\fB-s|--sync\fR] [\fB-v|--verbose\fR] [\fB--silent\fR] [\-\-] \fIvserver\fR \fIcommand\fR [\fB--help\fR] \fIargs*\fR 
    368.TP 
    37 \fBstatus\fR Tells various information about the state of a virtual server: 
    38 running status, number of running processes and uptime. 
     9\fB\-\-sync\fR - Perform synchronization with vshelper to ensure that the guest has been stopped 
    3910.TP 
    40 .I --nodev 
    41 do not configure the IP devices associated with the vserver. This 
    42 is useful to execute some commands on the vserver (or enter it) 
    43 without making it active on the network. Especially useful if you 
    44 have an active copy of the vserver moved to another server on the 
    45 network. 
     11\fB\-\-verbose\fR - Makes things a lot louder. 
    4612.TP 
    47 .I --silent 
    48 cuts most informative messages. 
    49  
     13\fB\-\-silent\fR - Removes most informative messages. 
     14.TP 
     15\fIvserver\fR - The name of a vserver. 
     16.TP 
     17\fIcommand\fR - One of the commands listed below. 
     18.TP 
     19\fB\-\-help\fR  
     20.IP 
     21provides additional help for provided \fIcommand\fR, for example: vserver - build --help 
     22\fIargs\fR are the arguments that are possible for the different commands, see the 
     23arguments for each \fIcommand\fR listed below 
     24.SH "COMMANDS" 
     25.TP 
     26\fBstart\fR [\fB\-\-rescue\fR [\fB\-\-rescue\-init\fR] \fIprogram args\fR]  
     27.IP 
     28\&Starts the specified vserver. The optional argument \fB--rescue\fR starts the 
     29vserver in rescue mode, which runs \fIprogram args*\fR to start the vserver 
     30instead of whatever is configured. The optional argument \fB--rescue-init\fR 
     31makes the command appear as PID 1 in the vserver. This can be used to start 
     32/bin/bash to investigate why a vserver is not able to start correctly. 
     33.TP 
     34\fBstop\fR [\fB\-\-rescue\-init\fR] 
     35.IP 
     36\&Stops the specified vserver, and kills the remaining processes. The optional 
     37argument \fB--rescue-init\fR can be used to stop a vserver that was started 
     38with the option of the same name. 
     39.TP 
     40\fBrestart\fR 
     41.IP 
     42\&Restarts the specified vserver. This is the subsequent execution of a 
     43synchronized 'stop' and a 'start'. 
     44.TP 
     45\fBcondrestart\fR 
     46.IP 
     47\&Restarts a running vserver. 
     48.TP 
     49\fBsuexec\fR \fIuser\fR \fIprogram args*\fR 
     50.IP 
     51\&Executes \fIprogram args*\fR as the specified \fIuser\fR in the vserver. 
     52.TP 
     53\fBexec\fR \fIprogram args*\fR 
     54.IP 
     55\&Executes \fIprogram args*\fR as the root user in the vserver. 
     56.TP 
     57\fBenter\fR 
     58.IP 
     59\&Executes the configured shell (default: /bin/bash if it exists) in the 
     60vserver and allocates a pty. 
     61.TP 
     62\fBchkconfig\fR \fIchkconfig\-options*\fR 
     63.IP 
     64\&Modifies the init\-system; currently, only Red Hat's \fBchkconfig\fR is 
     65supported. 
     66.TP 
     67\fBrunning\fR 
     68.IP 
     69\&Returns an exit code of 0 iff the vserver is running, 1 if not. 
     70.TP 
     71\fBstatus\fR 
     72.IP 
     73\&Provides some human readable status information about the vserver, and 
     74succeeds iff the vserver is running. 
     75.TP 
     76\fBbuild\fR \fIbuildopts*\fR 
     77.IP 
     78\&Create a vserver from scratch, where the \fIbuildopts*\fR are a set of 
     79options and a build method. As this option calls vserver-build, please see 
     80vserver-build(8) for a complete listing of possible options and methods. 
     81.TP 
     82\fBdelete\fR 
     83.IP 
     84\&Remove a vserver. 
     85.TP 
     86\fBunify\fR [\fB\-R\fR] [\fIvunify\-opts*\fR] 
     87.IP 
     88\&Unify or de-unify the vserver with its reference vserver(s). 
     89.TP 
     90\fBpkg install\fR \fIpkg*\fR 
     91.IP 
     92\&Installs package(s) \fIpkg\fR in the vserver. 
     93.TP 
     94\fBapt\-get,apt\-config,apt\-cache\fR \fIapt\-opts*\fR 
     95.IP 
     96\&Execute the apt\-* command for the given vserver 
     97.TP 
     98\fBrpm\fR \fIrpm\-opts*\fR 
     99.IP 
     100\&Execute the \fBrpm\fR command for the given vserver. 
     101.TP 
     102\fBpkgmgmt\fR \fBexternalize\fR|\fBinternalize\fR [\fB\-y\fR] 
     103.IP 
     104\&Externalize or internalize the package\-management for the given vserver. 
     105\'Externalize' means that package metadata and management tools (apt\-get,rpm) 
     106are living in the host, while 'internalize' means that data and programs from 
     107the vserver will be used. 
     108.TP 
     109\fBhashify\fR 
     110.IP 
     111\&Hashify the vserver. 
    50112.SH "FILES" 
    51113.LP  
    52114\fI/usr/sbin/vserver\fP  
    53115.P 
    54 \fI/etc/vservers/*.conf\fP  
     116\fI/etc/vservers/*\fP  
    55117.P 
    56 \fI/etc/vservers/*.sh\fP  
    57118.P 
    58 \fI/vservers/*\fP  
    59  
     119\fI/var/lib/vservers/*\fP  
    60120.SH "EXAMPLES" 
    61121.LP  
     
    63123.SH "AUTHORS" 
    64124.LP  
    65 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> 
     125This man page was written by Micah Anderson <micah@debian.org> and based upon the helpful output from the program itself. 
    66126.SH "SEE ALSO" 
    67127.LP  
    68128chbind(8) chcontext(8) 
    69 newvserver(8) 
    70129rebootmgr(8) reducecap(8) 
    71130vps(8) vpstree(8) 
    72131vrpm(8) 
     132vserver\-build(8) 
    73133vserver\-stat(8)  
    74134vtop(8)