diff options
author | erdgeist <erdgeist@erdgeist.org> | 2011-01-20 21:03:50 +0000 |
---|---|---|
committer | erdgeist <erdgeist@erdgeist.org> | 2011-01-20 21:03:50 +0000 |
commit | 712cdc830d1456cec055ffd9a96540c047c96225 (patch) | |
tree | a9356100d7d2ee2b997037bd5f6bfc0944723c34 /man8/ezjail-admin.8 | |
parent | 38bd97262a80fc5fb73b076115610eee501a6ea0 (diff) |
New man pages, also put in new sections
Diffstat (limited to 'man8/ezjail-admin.8')
-rw-r--r-- | man8/ezjail-admin.8 | 606 |
1 files changed, 606 insertions, 0 deletions
diff --git a/man8/ezjail-admin.8 b/man8/ezjail-admin.8 new file mode 100644 index 0000000..99b3110 --- /dev/null +++ b/man8/ezjail-admin.8 | |||
@@ -0,0 +1,606 @@ | |||
1 | .Dd January 15, 2011 | ||
2 | .Dt EZJAIL-ADMIN 8 USD | ||
3 | .Os FreeBSD | ||
4 | .Sh NAME | ||
5 | .Nm ezjail-admin | ||
6 | .Nd Administrate ezjail environment | ||
7 | .Sh SYNOPSIS | ||
8 | .Nm Cm install | ||
9 | .Op Fl mMpPsS | ||
10 | .Op Fl h Ar host | ||
11 | .Op Fl r Ar release | ||
12 | .Nm | ||
13 | .Cm create | ||
14 | .Op Fl bx | ||
15 | .Op Fl f Ar flavour | ||
16 | .Op Fl r Ar jailroot | ||
17 | .Op Fl a Ar archive | ||
18 | .Op Fl A Ar options | ||
19 | .Op Fl c Ar jailtype Fl s Ar imagesize Op Fl C Ar attachargs | ||
20 | .Bk -words | ||
21 | .Ar jailname ipaddress Ns Op Ar ,ipaddress2,... | ||
22 | .Ek | ||
23 | .Nm | ||
24 | .Cm console | ||
25 | .Op Fl f | ||
26 | .Op Fl e Ar command | ||
27 | .Ar jailname | ||
28 | .Nm | ||
29 | .Cm list | ||
30 | .Nm | ||
31 | .Cm start | stop | restart | cryptostart Ar jailname... | ||
32 | .Nm | ||
33 | .Cm config | ||
34 | .Op Fl r Ar run | norun | ||
35 | .Op Fl n Ar newname | ||
36 | .Op Fl i Ar attach | detach | fsck | ||
37 | .Op Fl z Ar newdataset | ||
38 | .Op Fl c Ar newcpuset | ||
39 | .Op Fl f Ar newfib | ||
40 | .Ar jailname | ||
41 | .Nm | ||
42 | .Cm delete | ||
43 | .Op Fl wf | ||
44 | .Ar jailname | ||
45 | .Nm | ||
46 | .Cm archive | ||
47 | .Op Fl Af | ||
48 | .Op Fl a Ar archive | ||
49 | .Op Fl d Ar archivedir | ||
50 | .Ar jailname... | ||
51 | .Nm | ||
52 | .Cm restore | ||
53 | .Op Fl f | ||
54 | .Op Fl d Ar archivedir | ||
55 | .Ar archive | jailname... | ||
56 | .Nm | ||
57 | .Cm update | ||
58 | .Op Fl s Ar sourcetree | ||
59 | .Op Fl p | ||
60 | .Fl b | Fl i | Fl P | Fl u | ||
61 | .Sh DESCRIPTION | ||
62 | The | ||
63 | .Nm | ||
64 | utility is used to manage the ezjail environment and all the jails inside the | ||
65 | ezjail scope. This man page describes the invocation of | ||
66 | .Nm . | ||
67 | Refer to | ||
68 | .Xr ezjail 7 | ||
69 | in order to get an introduction to the usage of ezjail, as well as | ||
70 | usage examples. | ||
71 | .Pp | ||
72 | The description of some options ends with | ||
73 | .Sq Variable: Dq Li $ezjail_abcd . | ||
74 | This means that the default value of the option may be overridden by setting | ||
75 | this variable in | ||
76 | .Xr ezjail.conf 5 , | ||
77 | which see. | ||
78 | .Ss Nm Cm install | ||
79 | This function sub-command is normally run once in the life of the ezjail | ||
80 | environment. It allocates the directory structure used by ezjail and populates | ||
81 | the base jail using the minimal distribution set from a FreeBSD FTP server. | ||
82 | .Pp | ||
83 | The default location for ezjail's basejail is in | ||
84 | .Pa /usr/jails , | ||
85 | so be sure you have enough space there (a FreeBSD base release without man | ||
86 | pages, sources and ports is around 120MB). This location may be modified in | ||
87 | .Xr ezjail.conf 5 . | ||
88 | .Pp | ||
89 | See also | ||
90 | .Nm | ||
91 | .Cm update | ||
92 | to install the base jail from source, as well as a method to update | ||
93 | the base jail using | ||
94 | .Xr freebsd-update 8 . | ||
95 | .Pp | ||
96 | The following options are available: | ||
97 | .Bl -tag -width indent | ||
98 | .It Fl m | ||
99 | Fetch and install man pages (ca. 10MB). | ||
100 | .It Fl M | ||
101 | Fetch and install man pages, without (re)installing the base jail. May be used | ||
102 | to add the man pages to the base jail after the intial installation. | ||
103 | .It Fl s | ||
104 | Fetch and install sources (ca. 450MB). | ||
105 | .It Fl S | ||
106 | Fetch and install sources, without (re)installing the base jail. | ||
107 | .It Fl p | ||
108 | Invoke the | ||
109 | .Xr portsnap 8 | ||
110 | utility to fetch and extract a FreeBSD ports tree from | ||
111 | .Li portsnap.FreeBSD.org | ||
112 | (ca. 475MB). When a ports tree is added to the base jail, a modified | ||
113 | .Pa make.conf | ||
114 | containing reasonable values to function in the jailed environment is added to | ||
115 | the new jail template so all jails created from the new jail template will | ||
116 | have a working ports environment. See the appendix | ||
117 | .%B Using Portsnap | ||
118 | in the | ||
119 | .%B FreeBSD Handbook | ||
120 | for details or | ||
121 | .Xr portsnap 8 . | ||
122 | .It Fl P | ||
123 | Fetch and extract a ports tree, without (re)installing the base jail. | ||
124 | .It Fl h Ar host | ||
125 | Set the remote host to fetch FreeBSD distribution sets from. If absent the | ||
126 | default host | ||
127 | .Li ftp.FreeBSD.org | ||
128 | is used. Variable: | ||
129 | .Dq Li $ezjail_ftphost . | ||
130 | .Pp | ||
131 | It is possible to install from the | ||
132 | .Li disc1 | ||
133 | CDRom, or an extracted -RELEASE directory, by specifying the | ||
134 | .Ar host | ||
135 | argument as | ||
136 | .Pa file://path/to/source . | ||
137 | .It Fl r Ar release | ||
138 | Install this release of FreeBSD in the base jail, instead of the version | ||
139 | returned by | ||
140 | .Dq Li uname -r | ||
141 | on the host system. Note that the FreeBSD FTP servers usually provide only | ||
142 | -RELEASE versions, not -STABLE nor -CURRENT versions; you will be prompted for | ||
143 | confirmation when trying to install a non -RELEASE version. If you want to | ||
144 | install a -CURRENT version, you may have to compile from source the base jail; | ||
145 | see the | ||
146 | .Nm Cm update | ||
147 | sub-command for this. | ||
148 | .El | ||
149 | .Ss Nm Cm create | ||
150 | Create a new jail inside ezjail's scope. It either copies the new jail | ||
151 | directory tree template or an ezjail archive directory tree to | ||
152 | .Pa /usr/jails/ Ns Ar jailname | ||
153 | directory tree. Jailname and IP address are mandatory parameters. | ||
154 | .Pp | ||
155 | When a new jail is created, a corresponding new | ||
156 | .Pa /etc/fstab. Ns Ar jailname | ||
157 | file is also created, with a | ||
158 | .Xr nullfs 5 | ||
159 | mount giving access to the base jail from the new jail. | ||
160 | .Pp | ||
161 | The following operands are mandatory: | ||
162 | .Bl -tag -width indent | ||
163 | .It Ar jailname | ||
164 | The name of the jail. It is customary to use the network name of the jail, | ||
165 | such as | ||
166 | .Dq Li jail1.example.com | ||
167 | (or maybe simply | ||
168 | .Dq Li jail1 ) , | ||
169 | but really any name may be used. | ||
170 | .Pp | ||
171 | It is an error to have several jails of the same name. | ||
172 | .It Ar ipaddress Ns Op Ar ,ipaddress2,... | ||
173 | The IP address or addresses of the jail. Since FreeBSD 7.2, it is possible to | ||
174 | assign several several IPv4 or IPv6 addresses to a jail, by separating them | ||
175 | with commas. Previous versions of FreeBSD allowed only a single IPv4 address | ||
176 | per jail. | ||
177 | .Pp | ||
178 | The addresses of the jail are not configured on the host. | ||
179 | .Nm | ||
180 | will display a warning if the requested address is not found on any interface, | ||
181 | and the jail will probably not start. | ||
182 | .Pp | ||
183 | XXX: is the following relevant, except maybe the warning about dynamic | ||
184 | addresses? | ||
185 | .Pp | ||
186 | This is the static (premanent, never changes) public internet | ||
187 | routable ip address assigned to you by your ISP. If you purchased a | ||
188 | continous block of static public internet routable ip address, then each | ||
189 | jail could be assigned one of those individual ip address from the block. | ||
190 | .Pp | ||
191 | Normally phone dialup PPP access and cable providers assign | ||
192 | dynamic ip address. The assigned ip address may change every time you | ||
193 | dialup and with cable providers when the lease time expires or you | ||
194 | reboot your system. \fBUse dynamic ip address at your own risk.\fR | ||
195 | .Pp | ||
196 | On the host issue 'ifconfig -a' command to see your assigned ip address. | ||
197 | Your host /etc/rc.conf should have ifconfig_XXX="DHCP" where XXX is | ||
198 | the 'unit name' of the NIC card facing the public internet. You will | ||
199 | also need this same ifconfig_XXX="DHCP" statement in the rc.conf of | ||
200 | each jail to enable the public network for that jail. | ||
201 | .Pp | ||
202 | If your host is acting as a 'gateway' (IE. has a LAN behind it), you | ||
203 | can provide jails for LAN access only. In this configuration your host | ||
204 | /etc/rc.conf should have ifconfig_XXX="inet x.x.x.x" where XXX is | ||
205 | the 'unit name' of the NIC card facing the private LAN | ||
206 | (local-area-network), where x.x.x.x is a private ip address from the | ||
207 | list of reserved non-public routable ip address. You will also need | ||
208 | this same ifconfig_XXX="inet x.x.x.x" statement in the rc.conf of each | ||
209 | jail to enable the lan network for that jail. | ||
210 | .El | ||
211 | .Pp | ||
212 | The following options are available: | ||
213 | .Bl -tag -width indent | ||
214 | .It Fl r Ar jailroot | ||
215 | Use this name as the directory name of the new jail. Without this option, it | ||
216 | is derived from the jail's name. If this option is given and does not start | ||
217 | with a '/', it is interpreted as relative to ezjail's root directory | ||
218 | .Pa (/usr/jails | ||
219 | by default). If a specified jailroot path lies outside the ezjail root | ||
220 | directory, a soft link is created inside | ||
221 | .Pa /usr/jails/ | ||
222 | pointing to the location of the newly created jail. | ||
223 | .It Fl a Ar archive | ||
224 | Restore a jail from an archive created with | ||
225 | .Nm Cm archive . | ||
226 | The archive files are kept in | ||
227 | .Pa /usr/jails/archive | ||
228 | by default. Use | ||
229 | .Pa - | ||
230 | to restore an archive from the standard input. | ||
231 | .Pp | ||
232 | You will probably need to tidy up things inside an ezjail if you migrate it | ||
233 | between different ezjail environments. This may include (but is not limited | ||
234 | to) reinstalling ports or packages for different CPUs or library versions. You | ||
235 | may also need to copy some libraries from the source host's base jail. | ||
236 | .Pp | ||
237 | See also | ||
238 | .Nm Cm restore , | ||
239 | if you only want to revert to an old jail's state from an archive on the same | ||
240 | release version. | ||
241 | .It Fl A Ar jailconf | ||
242 | Copy the comments, in particular the | ||
243 | .Dq Li PROVIDE , | ||
244 | .Dq Li REQUIRE | ||
245 | and | ||
246 | .Dq Li BEFORE | ||
247 | lines, from this jail. | ||
248 | .Pp | ||
249 | XXX: This is my understanding from the code. Is that correct? | ||
250 | .It Fl x | ||
251 | This flag indicates that an jail of that name already exists. In this case, | ||
252 | ezjail will only update the configuration of the jail. Sanity checks are | ||
253 | performed. | ||
254 | .It Fl f Ar flavour | ||
255 | Install the requested | ||
256 | .Ar flavour | ||
257 | in the new jail. | ||
258 | .Pp | ||
259 | This option may not be used with the | ||
260 | .Fl a | ||
261 | option. | ||
262 | .It Fl c Cm simple | bde | eli | zfs | ||
263 | Create a jail of the given type. | ||
264 | .Pp | ||
265 | A | ||
266 | .Cm simple | ||
267 | jail is backed with a single file. The jail will not be allowed to grow beyond | ||
268 | its allocated size. The base jail is included in the image, making it portable | ||
269 | between hosts running the same (or sufficiently close) version of FreeBSD. The | ||
270 | jail will be stored in a file named | ||
271 | .Ar jailname Ns Pa .img , | ||
272 | unless | ||
273 | .Fl r Ar jailroot | ||
274 | is given, in which case the jail is stored in | ||
275 | .Ar jailroot Ns Pa .img . | ||
276 | .Pp | ||
277 | A | ||
278 | .Cm bde No or Cm eli | ||
279 | jail is a | ||
280 | .Cm simple | ||
281 | jail whose file has been encrypted using | ||
282 | .Xr gbde 4 | ||
283 | (for | ||
284 | .Cm bde ) | ||
285 | or | ||
286 | .Xr geli 8 | ||
287 | (for | ||
288 | .Cm eli ) . | ||
289 | See also the | ||
290 | .Fl C | ||
291 | flag when creating this kind of jail. | ||
292 | .Pp | ||
293 | A | ||
294 | .Cm zfs | ||
295 | jail is backed with a | ||
296 | .Xr zfs 8 | ||
297 | volume, whose initial quota is given with the | ||
298 | .Fl s | ||
299 | option. The volume is compressed using the lzjb method. The volume is created | ||
300 | in the | ||
301 | .Cm ezjail_jailzfs | ||
302 | data set, if set in | ||
303 | .Xr ezjail.conf 5 . | ||
304 | .Pp | ||
305 | XXX: from the code, it looks like the user needs to have done | ||
306 | ezjail-admin install with ezjail_use_zfs. Is that correct? | ||
307 | .Pp | ||
308 | In each case, the | ||
309 | .Fl s | ||
310 | flag is mandatory when creating such a jail. An empty directory (without the | ||
311 | .Pa .img | ||
312 | suffix in the case of file-based jails) will be created and used as a mount | ||
313 | point when running the jail. | ||
314 | .It Fl s Ar imagesize | ||
315 | Allocate this size to the jail. Without an unit, the size is in bytes. The | ||
316 | valid suffix values are b/B for bytes, k/K for kilobytes, m/M for megabytes, | ||
317 | and g/G for gigabytes. As a reference point, a newly created jail requires | ||
318 | 2MB. | ||
319 | .Pp | ||
320 | It is not possible to increase the size of file-based jails after their | ||
321 | creation, short of creating a new image jail with a larger size. | ||
322 | .It Fl C Ar imageopt | ||
323 | Pass this argument to | ||
324 | .Li gbde No or Li geli init . | ||
325 | .Fl P No and Fl K | ||
326 | (and | ||
327 | .Fl L | ||
328 | for | ||
329 | .Xr gbde 4 ) | ||
330 | will be translated and passed to | ||
331 | .Li gbde No or Li geli attach | ||
332 | when starting the jail. | ||
333 | .It Fl i | ||
334 | Synonym of | ||
335 | .Fl c Cm simple . | ||
336 | .It Fl b | ||
337 | Don't start the jail at boot time. | ||
338 | .El | ||
339 | .Ss Nm Cm console | ||
340 | Attach your console to the selected jail. You are logged in as root by | ||
341 | default. The command line prompt shows the name of the jail. You have to | ||
342 | use the pwd command to see where in the directory tree you are. Entering | ||
343 | \fBexit\fR will terminate the jail console. | ||
344 | .Pp | ||
345 | The following options are available: | ||
346 | .Bl -tag -width indent | ||
347 | .It Fl f | ||
348 | Start the jail if it is not running yet. | ||
349 | .It Fl e Ar command | ||
350 | Use | ||
351 | .Ar command | ||
352 | instead of | ||
353 | .Dq /usr/bin/login -f root . | ||
354 | A one time change to use a different user can be accomplished by using | ||
355 | .Fl e Qq Li /usr/bin/login -f user . | ||
356 | Variable: | ||
357 | .Dq Li $ezjail_default_execute . | ||
358 | .El | ||
359 | .Ss Nm Cm list | ||
360 | List all jails inside ezjail's scope. They are sorted by the order they start | ||
361 | up, as defined by | ||
362 | .Xr rcorder 1 . | ||
363 | .Pp | ||
364 | The first column is the status flag consisting of 2 or 3 letters. The first | ||
365 | letter is the type of jail: | ||
366 | .Bl -tag -width 4n -offset indent -compact | ||
367 | .It Sy D | ||
368 | Directory tree based jail. | ||
369 | .It Sy I | ||
370 | File-based jail. | ||
371 | .It Sy E | ||
372 | Geli encrypted file-based jail. | ||
373 | .It Sy B | ||
374 | Bde encrypted file-based jail. | ||
375 | .It Sy Z | ||
376 | ZFS filesystem-based jail. | ||
377 | .El | ||
378 | .Pp | ||
379 | The second letter is the status of the jail: | ||
380 | .Bl -tag -width 4n -offset indent -compact | ||
381 | .It Sy R | ||
382 | The jail is running. | ||
383 | .It Sy A | ||
384 | The image of the jail is mounted, but the jail is not running. | ||
385 | .It Sy S | ||
386 | The jail is stopped. | ||
387 | .El | ||
388 | .Pp | ||
389 | If present, the third letter, | ||
390 | .Sy N , | ||
391 | means that the jail is not automatically started. | ||
392 | .Pp | ||
393 | The following columns are the JID (when it is running), the IP addresses, the name and the full path directory name of the jail. | ||
394 | .Ss Nm Cm start | stop | restart | cryptostart Op Ar jailname ... | ||
395 | Execute the given action on | ||
396 | .Ar jailname , | ||
397 | or on all jails if the operand is omitted. Several jails may be specified. | ||
398 | .Pp | ||
399 | As this is just a shortcut to the | ||
400 | .Xr rc 8 | ||
401 | .Cm ezjail | ||
402 | script, if ezjail is not enabled in | ||
403 | .Xr rc.conf 5 | ||
404 | with | ||
405 | .Dq Li ezjail_enable= Ns Qq Li YES , | ||
406 | nothing will be done. Prefix the action with | ||
407 | .Cm one | ||
408 | (as in | ||
409 | .Cm onestart , | ||
410 | etc.) to force the action regardless of the value of | ||
411 | .Dq Li $ezjail_enable . | ||
412 | .Pp | ||
413 | .Cm cryptostart | ||
414 | is used to start jails that use | ||
415 | .Xr gbde 4 | ||
416 | or | ||
417 | .Xr geli 8 | ||
418 | encryption. Those jails require interaction with the administrator | ||
419 | when starting. | ||
420 | .Ss Nm Cm config Ar jailname | ||
421 | Manage parameters of specific ezjails. For running jails, most of the | ||
422 | configuration changes described below will not be applied until the next time | ||
423 | the jail is restarted. | ||
424 | .Pp | ||
425 | The following options are available: | ||
426 | .Bl -tag -width indent | ||
427 | .It Fl r Cm run | norun | ||
428 | Set the jail to be automatically started or not on boot. | ||
429 | .It Fl n An newname | ||
430 | Rename the jail. Unless a custom root directory was given with the | ||
431 | .Fl r | ||
432 | flag when creating the jail, the root directory will be renamed as well. A | ||
433 | running jail may not be renamed. | ||
434 | .It Fl i Cm attach | detach | fsck | ||
435 | Only valid for stopped image jails. Attaching a jail means making the content | ||
436 | of the root of the jail accessible from the host. No other sub-commands will | ||
437 | function on an jail while its image is attached. With | ||
438 | .Cm fsck , | ||
439 | the image jail is attached, | ||
440 | .Xr fsck 8 | ||
441 | is run, then the image jail is detached. You can only fsck image based jails. | ||
442 | .It Fl z Ar newdataset | ||
443 | Set the given ZFS dataset to be mounted inside the jail file system | ||
444 | when it is started. | ||
445 | .It Fl f Ar newfib | ||
446 | Change the FIB of the jail (see | ||
447 | .Xr setfib 2 ) . | ||
448 | .It Fl c Ar newcpuset | ||
449 | Change the CPU affinity set of the jail (see | ||
450 | .Xr cpuset 2 ) . | ||
451 | .El | ||
452 | .Ss Nm Cm delete Ar jailname | ||
453 | Delete a jail. By default, this command only deletes ezjail's control file for | ||
454 | the selected jail as well as | ||
455 | .Pa /etc/fstab. Ns Ar jailname . | ||
456 | The | ||
457 | .Pa /usr/jails/ Ns Ar jailname | ||
458 | directory is not deleted. | ||
459 | .Pp | ||
460 | .Bl -tag -width indent | ||
461 | .It Fl f | ||
462 | Stop the jail before deleting it. | ||
463 | .It Fl w | ||
464 | Delete the directory or the file backing the jail. | ||
465 | .El | ||
466 | .Ss Nm Cm archive | ||
467 | Create a backup of one, multiple or all ezjails. The specified service | ||
468 | jail's root directory tree is backed up as a | ||
469 | .Xr pax 1 | ||
470 | file. The jail needs to be stopped. | ||
471 | .Pp | ||
472 | See | ||
473 | .Nm Cm restore | ||
474 | or | ||
475 | .Nm Cm create Fl a Ar archive | ||
476 | to restore an archive. | ||
477 | .Pp | ||
478 | The basejail can not be archived. There is no ezjail function to | ||
479 | delete archive files; they may be removed from the host using | ||
480 | .Xr rm 1 . | ||
481 | .Bl -tag -width indent | ||
482 | .It Fl a Ar archivename | ||
483 | Use this name for the archive file. If absent, the archive file name | ||
484 | is derived from the jail name, with the date and time of the archive | ||
485 | appended to the file name. | ||
486 | .It Fl d Ar directory | ||
487 | Save the archive in this directory. If this option is not given and | ||
488 | .Dq Li $ezjail_archivedir | ||
489 | is not set, the archive is saved in the default directory. | ||
490 | Variable: | ||
491 | .Dq Li $ezjail_archivedir . | ||
492 | .It Fl f | ||
493 | Archive the jail even when it is running. | ||
494 | .It Fl A | ||
495 | Archive all jails. | ||
496 | .It Ar jailname | ||
497 | Archive only this jail. This argument is mandatory if | ||
498 | .Fl a | ||
499 | is not given. | ||
500 | .El | ||
501 | .Ss Nm Cm restore | ||
502 | Create new ezjails from archived versions. It tries to collect all | ||
503 | information necessary to do that without user interaction from the | ||
504 | user. | ||
505 | .Pp | ||
506 | The following operand is mandatory: | ||
507 | .Bl -tag -width indent | ||
508 | .It Ar archive | jailname | ||
509 | Restore this jail. If only the jail name is given, | ||
510 | .Nm | ||
511 | will use the most recent archive file matching the name you specified. | ||
512 | To restore an older version, specify the complete archive file name | ||
513 | (file name with the date and time of the archive appended to it). | ||
514 | .El | ||
515 | The following options are available: | ||
516 | .Bl -tag -width indent | ||
517 | .It Fl d Ar archivedir | ||
518 | Search the archive file in this directory. If this option is not given and | ||
519 | .Dq Li $ezjail_archivedir | ||
520 | is not set, the archive is searched in the current directory. Variable: | ||
521 | .Dq Li $ezjail_archivedir . | ||
522 | .It Fl f | ||
523 | Restore the archive even if running on a host different from | ||
524 | where it was archived. Be default, | ||
525 | .Nm | ||
526 | will refuse to restore an archive if the hostname, the FreeBSD version | ||
527 | or the CPU architecture is modified. | ||
528 | .El | ||
529 | .Ss Nm Cm update | ||
530 | Creates or updates ezjail's basejail from source. This performs a | ||
531 | .Dq make world ; make installworld | ||
532 | using the basejail's RELEASE source located at | ||
533 | .Pa /usr/src | ||
534 | (but see the | ||
535 | .Fl s | ||
536 | option). Exactly one of | ||
537 | .Fl b , i , u , P | ||
538 | is mandatory. | ||
539 | .Pp | ||
540 | See the | ||
541 | .Cm install | ||
542 | command to install the basejail from binary packages. | ||
543 | .Pp | ||
544 | Exactly one of the following operand must be specified: | ||
545 | .Bl -tag -width indent | ||
546 | .It Fl b | ||
547 | Build and install a world from source located in the basejail. | ||
548 | .It Fl i | ||
549 | Perform a | ||
550 | .Qq make installworld , | ||
551 | assuming the world has already been built. | ||
552 | .It Fl u | ||
553 | Use | ||
554 | .Xr freebsd-update 8 | ||
555 | to update the basejail. Note that as | ||
556 | .Xr freebsd-update 8 | ||
557 | uses | ||
558 | .Dq Li uname -r | ||
559 | to determine the currently running system, the base jail and the host | ||
560 | need to be updated at the same time, without rebooting on the new | ||
561 | kernel in the meantime. | ||
562 | .Pp | ||
563 | Jails that are stored in a ZFS volume are snapshot first. | ||
564 | .It Fl P | ||
565 | Install only the ports tree, assuming the basejail has already been | ||
566 | created.This can be done while jails are running. The | ||
567 | .Xr portsnap 8 | ||
568 | utility is invoked to do the actual work. | ||
569 | .El | ||
570 | The following options are available: | ||
571 | .Bl -tag -width indent | ||
572 | .It Fl p | ||
573 | Give the new basejail a copy of FreeBSD's ports tree. The | ||
574 | .Xr portsnap 8 | ||
575 | utility is invoked to do the actual work. | ||
576 | .It Fl s Ar sourcedir | ||
577 | Use the sources in | ||
578 | .Ar sourcedir | ||
579 | instead of | ||
580 | .Pa /usr/src . | ||
581 | Variable: | ||
582 | .Dq Li $ezjail_sourcetree . | ||
583 | .El | ||
584 | .Sh FILES | ||
585 | .Pa EZJAIL_PREFIX/bin/ezjail-admin | ||
586 | .br | ||
587 | .Pa EZJAIL_PREFIX/etc/rc.d/ezjail.sh | ||
588 | .br | ||
589 | .Pa EZJAIL_PREFIX/etc/ezjail.conf | ||
590 | .br | ||
591 | .Pa EZJAIL_PREFIX/share/examples/ezjail/ | ||
592 | .br | ||
593 | .Pa EZJAIL_PREFIX/etc/ezjail/* | ||
594 | .br | ||
595 | .Pa /usr/etc/fstab.* | ||
596 | .Sh SEE ALSO | ||
597 | .Xr ezjail 7 , | ||
598 | .Xr ezjail.conf 8 , | ||
599 | .Xr jail 8 , | ||
600 | .Xr devfs 5 , | ||
601 | .Xr fdescfs 5 , | ||
602 | .Xr procfs 5 , | ||
603 | .Xr portsnap 8 . | ||
604 | .Sh AUTHOR | ||
605 | .An Dirk Engling | ||
606 | .Aq erdgeist@erdgeist.org . | ||