Install the F8/F9 keys.
[util-vserver.git] / man / vserver.8
1 .TH VSERVER 8 "October 24, 2007" "util-vserver" "System Administration"
2 .SH "NAME"
3 .LP 
4 vserver \- 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
8 .TP
9 \fB\-\-sync\fR - Perform synchronization with vshelper to ensure that the guest has been stopped
10 .TP
11 \fB\-\-verbose\fR - Makes things a lot louder.
12 .TP
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
21 provides 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
23 arguments 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
29 vserver in rescue mode, which runs \fIprogram args*\fR to start the vserver
30 instead of whatever is configured. The optional argument \fB--rescue-init\fR
31 makes 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
37 argument \fB--rescue-init\fR can be used to stop a vserver that was started
38 with 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
43 synchronized '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
60 vserver 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
65 supported.
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
74 succeeds 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
79 options and a build method. As this option calls vserver-build, please see
80 vserver-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)
106 are living in the host, while 'internalize' means that data and programs from
107 the vserver will be used.
108 .TP
109 \fBhashify\fR
110 .IP
111 \&Hashify the vserver.
112 .SH "FILES"
113 .LP 
114 \fI/usr/sbin/vserver\fP 
115 .P
116 \fI/etc/vservers/*\fP 
117 .P
118 .P
119 \fI/var/lib/vservers/*\fP 
120 .SH "EXAMPLES"
121 .LP 
122 Please contribute some, if you feel it's important.
123 .SH "AUTHORS"
124 .LP 
125 This man page was written by Micah Anderson <micah@debian.org> and based upon the helpful output from the program itself.
126 .SH "SEE ALSO"
127 .LP 
128 chbind(8) chcontext(8)
129 rebootmgr(8) reducecap(8)
130 vps(8) vpstree(8)
131 vrpm(8)
132 vserver\-build(8)
133 vserver\-stat(8) 
134 vtop(8)