Tagging module util-vserver - util-vserver-0.30.215-6
[util-vserver.git] / man / vserver-build.8.pathsubst
1 .TH VSERVER-BUILD "8" "October 27, 2007" "vserver-build" "System Administration"
2 .SH "NAME"
3 vserver-build \- initializes a vserver
4 .SH SYNTAX
5 .B vserver-build
6 \fB\-m\fR \fImethod\fR \fB\-n\fR \fIname\fR [\fB\-\-force\fR] [\fB\-\-keep\fR]
7 [\fB\-\-rootdir\fR \fIdir\fR] [\fB\-\-pkgbase\fR \fIdir\fR]
8 \fIconfig options*\fR [\fB\-\-\fR] \fImethod arguments*\fR
9 .TP
10 \fB\-m\fR \fImethod\fR
11 Use build \fImethod\fR; see below for possible values.
12 .TP
13 \fB\-n\fR \fIname\fR
14 Name of vserver you are building.
15 .TP
16 \fB\-\-force\fR 
17 Remove/rename already existing vservers with the same name.
18 .TP
19 \fB\-\-keep\fR 
20 Do not delete generated files and directories if vserver build fails.
21 .TP
22 \fB\-\-rootdir\fR \fIdir\fR
23 Root vserver directory [default: @SYSCONFDIR@/vservers/.defaults/vdirbase].
24 .TP
25 \fB\-\-pkgbase\fR \fIdir\fR
26 Package base directory [default: @VSERVERDIR@/.pkg].
27 .SH "CONFIG OPTIONS"
28 .TP
29 \fB\-\-context\fR \fInum\fR
30 .IP
31 \&The static context of the vserver [default: none; one will be generated for you].
32 The valid range is 2 through 49151.
33 .TP
34 \fB\-\-confdir\fR \fIdir\fR
35 .IP
36 \&The vserver configuration directory to use [default: @SYSCONFDIR@/vservers/<name>].
37 .TP
38 \fB\-\-lockfile\fR \fIfilename\fR
39 .IP
40 \&The lockfile to use [default: /var/run/vservers/<name>].
41 .TP
42 \fB\-\-hostname\fR \fIhostname\fR
43 .IP
44 \&Hostname of the vserver.
45 .TP
46 \fB\-\-netdev\fR \fIdevice\fR
47 .IP
48 \&The default interface to use for \fB--interface\fR.
49 .TP
50 \fB\-\-netbcast\fR \fIbroadcast\fR
51 .IP
52 \&Broadcast address to associate with the vserver.
53 .TP
54 \fB\-\-netmask\fR \fInetmask\fR|\fB\-\-netprefix\fR \fIprefixlen\fR
55 .IP
56 \&Sets the default netmask (a.b.c.d quadruple) or prefixlen (length of the
57 network).
58 .TP
59 \fB\-\-interface\fR [\fIname\-suffix\fR=][\fIdevice\fR:]\fIip\fR[/\fImask|prefixlen\fR]
60 .IP
61 \&Declares a network\-interface name and associated IP/netmask; this option can
62 be specified multiple times.
63 .TP
64 \fB\-\-flags\fR \fIflags+\fR
65 .IP
66 \&Sets comma\-separated list of flags; see lib/cflags-v13.c for a list.
67 .TP
68 \fB\-\-cpuset\fR \fIname\fR
69 .IP
70 \&Declares the CPUSET this vserver will run in [default: none]
71 .TP
72 \fB\-\-cpusetcpus\fR \fInumber[\-number][:exclusive]\fR
73 .IP
74 \&Sets which CPUs belong to the CPUSET, \fI:exclusive\fR is a flag (0|1)
75 prohibiting any other cpuset from using those CPUs.
76 .TP
77 \fB\-\-cpusetmems\fR \fInumber[\-number][:exclusive]\fR
78 .IP
79 \&Sets which memory pools belong to the CPUSET, \fI:exclusive\fR is a flag
80 (0|1) prohibiting any other cpuset from using those memory pools.
81 .TP
82 \fB\-\-cpusetvirt\fR
83 .IP
84 \&Virtualize the cpuset (the vserver will see only CPUs defined in the cpuset).
85 Requires kernel patch from http://www.bullopensource.org/cpuset/
86 .TP
87 \fB\-\-initstyle\fR \fIstyle\fR
88 .IP
89 \&Configures the initstyle (e.g. minit, sysv, plain, gentoo)
90 .SH "METHODS"
91 .TP
92 \fBapt\-rpm\fR
93 .IP
94 \& \fB\-\-\fR \fB\-d\fR \fIdistribution\fR
95
96 \&Installs the base\-packages of the given distribution with the help of
97 '\fBvapt\-get\fR'
98 .TP
99 \fByum\fR
100 .IP
101 \&\fB\-\-\fR \fB\-d\fR \fIdistribution\fR
102
103 \&Installs the base\-packages of the given distribution with help of
104 '\fBvyum\fR'
105 .TP
106 \fBrpm\fR
107 .IP
108 \&\fB\-\-\fR [\fB\-d\fR \fIdistribution\fR] \fB\-\-empty\fR|([\fB\-\-force\fR] [\fB\-\-nodeps\fR] \fImanifest\fR)+
109
110 \&Installs lists of rpm\-packages
111 .TP
112 \fBskeleton\fR
113 .IP
114 \&\fB\-\-\fR [\fIcmd args*\fR]
115
116 \&Installs a minimal skeleton filesystem, creates the configuration file
117 and calls an optional command
118 .TP
119 \fBdebootstrap\fR
120 .IP
121 \fB\-\-\fR \fB\-d\fR \fIdistribution\fR [\fB\-m\fR \fImirror\fR] [\fB\-s\fR \fIscript\fR] [\fB\-\-\fR \fIdebootstrap\-options*\fR]
122
123 \&Bootstraps the vserver with Debian's 'debootstrap' package
124 .TP
125 \fBtemplate\fR
126 .IP
127 \&\fB\-\-\fR (\fB\-t\fR \fItarball\fR)+ [\fB\-d\fR \fIdistribution\fR]
128
129 \&Installs a vserver using tarball(s)
130 .TP
131 \fBfai\fR
132 .IP
133 \&\fB\-\-\fR [\fB\-f\fR \fIfai_vserver\fR] [\fB\-n\fR \fInfsroot\fR] [\fB\-d\fR \fIfai_dir\fR] [\fB\-a\fR]
134
135 \&Bootstraps the vserver with the Debian Fully Automatic Installation
136
137 \fB\-f\fR means use the nfsroot and profile in the vserver \fIfai_vserver\fR
138
139 \fB\-n\fR \fInfsroot\fR specifies the 'NFS' root explicitly
140
141 \fB\-d\fR \fIfai_dir\fR specifies the location of the FAI profile
142
143 the \fB\-f\fR option implies \fB\-n\fR and \fB\-d\fR are relative to the \fIfai_vserver\fR
144 .TP
145 \fBrsync\fR
146 .IP
147 \&\fB\-\-\fR [\fB\-d\fR \fIdistribution\fR] \fB\-\-source\fR \fIsource\fR [\fB\-o\fR \fIrsync option\fR]*
148
149 \&Installs a vserver by rsyncing from \fIsource\fR to the guest root
150 .TP
151 \fBclone\fR
152 .IP
153 \&\fB\-\-\fR [\fB\-d\fR \fIdistribution\fR] \fB\-\-source\fR \fIsource\fR
154
155 \&Clones a vserver by linking unified files and copying the rest
156 .SH "EXAMPLES"
157 .LP
158 # vserver kea build -m debootstrap --context 10 --hostname kea --interface eth0:192.168.0.44/32 -- -d etch
159 .SH "BUGS"
160 .LP
161 Please report bugs to vserver@list.linux\-vserver.org
162 .SH "AUTHORS"
163 .LP
164 This man page was written by Micah Anderson <micah@debian.org> and based upon the helpful output from the program itself.
165 .SH "SEE ALSO"
166 .PP
167  chbind(8) chcontext(8)
168  rebootmgr(8) reducecap(8)
169  vps(8) vpstree(8)
170  vrpm(8)
171  vserver\-stat(8)
172  vtop(8)
173