diff options
Diffstat (limited to 'man8/ezjail-admin.8')
-rw-r--r-- | man8/ezjail-admin.8 | 26 |
1 files changed, 12 insertions, 14 deletions
diff --git a/man8/ezjail-admin.8 b/man8/ezjail-admin.8 index 7e809cf..f40f73a 100644 --- a/man8/ezjail-admin.8 +++ b/man8/ezjail-admin.8 | |||
@@ -3,7 +3,7 @@ | |||
3 | .Os FreeBSD | 3 | .Os FreeBSD |
4 | .Sh NAME | 4 | .Sh NAME |
5 | .Nm ezjail-admin | 5 | .Nm ezjail-admin |
6 | .Nd Administrate ezjail environment | 6 | .Nd Administrate ezjail environment |
7 | .Sh SYNOPSIS | 7 | .Sh SYNOPSIS |
8 | .Nm Cm install | 8 | .Nm Cm install |
9 | .Op Fl mMpPsS | 9 | .Op Fl mMpPsS |
@@ -115,7 +115,7 @@ utility to fetch and extract a FreeBSD ports tree from | |||
115 | .Pa make.conf | 115 | .Pa make.conf |
116 | containing reasonable values to function in the jailed environment is added to | 116 | containing reasonable values to function in the jailed environment is added to |
117 | the new jail template so all jails created from the new jail template will | 117 | the new jail template so all jails created from the new jail template will |
118 | have a working ports environment. See the appendix | 118 | have a working ports environment. See the appendix |
119 | .%B Using Portsnap | 119 | .%B Using Portsnap |
120 | in the | 120 | in the |
121 | .%B FreeBSD Handbook | 121 | .%B FreeBSD Handbook |
@@ -130,7 +130,7 @@ default host | |||
130 | is used. Variable: | 130 | is used. Variable: |
131 | .Dq Li $ezjail_ftphost . | 131 | .Dq Li $ezjail_ftphost . |
132 | .Pp | 132 | .Pp |
133 | It is possible to install from the | 133 | It is possible to install from the |
134 | .Li disc1 | 134 | .Li disc1 |
135 | CD-ROM, or an extracted -RELEASE directory, by specifying the | 135 | CD-ROM, or an extracted -RELEASE directory, by specifying the |
136 | .Ar host | 136 | .Ar host |
@@ -157,7 +157,7 @@ by default. Jailname and IP address are mandatory parameters. | |||
157 | .Pp | 157 | .Pp |
158 | When a new jail is created, a corresponding new | 158 | When a new jail is created, a corresponding new |
159 | .Pa /etc/fstab. Ns Ar jailname | 159 | .Pa /etc/fstab. Ns Ar jailname |
160 | file is also created, with a | 160 | file is also created, with a |
161 | .Xr nullfs 5 | 161 | .Xr nullfs 5 |
162 | mount giving access to the base jail from the new jail. | 162 | mount giving access to the base jail from the new jail. |
163 | .Pp | 163 | .Pp |
@@ -342,7 +342,7 @@ interactively enter a passphrase. The jail is then not automatically started | |||
342 | at boot time. | 342 | at boot time. |
343 | .El | 343 | .El |
344 | .Ss Nm Cm console | 344 | .Ss Nm Cm console |
345 | Attach your console to the selected jail. You are logged in as root by | 345 | Attach your console to the selected jail. You are logged in as root by |
346 | default. | 346 | default. |
347 | .Pp | 347 | .Pp |
348 | The following options are available: | 348 | The following options are available: |
@@ -396,7 +396,6 @@ means that the jail is not automatically started. | |||
396 | .Pp | 396 | .Pp |
397 | The following columns are the JID (when it is running), the IP addresses, the name and the full path directory name of the jail. | 397 | The following columns are the JID (when it is running), the IP addresses, the name and the full path directory name of the jail. |
398 | .Ss Nm Cm start | restart | stop | startcrypto | stopcrypto Op Ar jailname ... | 398 | .Ss Nm Cm start | restart | stop | startcrypto | stopcrypto Op Ar jailname ... |
399 | .Pp | ||
400 | This is a shortcut to the | 399 | This is a shortcut to the |
401 | .Xr rc 8 | 400 | .Xr rc 8 |
402 | .Cm ezjail | 401 | .Cm ezjail |
@@ -410,7 +409,7 @@ Note that, if ezjail is not enabled in | |||
410 | .Xr rc.conf 5 | 409 | .Xr rc.conf 5 |
411 | with | 410 | with |
412 | .Dq Li ezjail_enable= Ns Qq Li YES , | 411 | .Dq Li ezjail_enable= Ns Qq Li YES , |
413 | nothing happens. | 412 | nothing happens. |
414 | .Pp | 413 | .Pp |
415 | Since starting crypto image jails requires interaction with the administrator, they are not run at | 414 | Since starting crypto image jails requires interaction with the administrator, they are not run at |
416 | boot time. Use | 415 | boot time. Use |
@@ -424,7 +423,7 @@ The following options are available: | |||
424 | .Bl -tag -width indent | 423 | .Bl -tag -width indent |
425 | .It Fl r Cm run | norun | test | 424 | .It Fl r Cm run | norun | test |
426 | Set the jail to be automatically started or not on boot. | 425 | Set the jail to be automatically started or not on boot. |
427 | 426 | .sp | |
428 | Note that the test parameter can be used to check if an ezjail exists, in this case the script will return with an exit code of zero and the runnable state on standard out. A non-zero exit code will be returned if the jail does not exist. | 427 | Note that the test parameter can be used to check if an ezjail exists, in this case the script will return with an exit code of zero and the runnable state on standard out. A non-zero exit code will be returned if the jail does not exist. |
429 | .It Fl n Ar newname | 428 | .It Fl n Ar newname |
430 | Rename the jail. Unless a custom root directory was given with the | 429 | Rename the jail. Unless a custom root directory was given with the |
@@ -456,7 +455,6 @@ the selected jail as well as | |||
456 | The | 455 | The |
457 | .Pa /usr/jails/ Ns Ar jailname | 456 | .Pa /usr/jails/ Ns Ar jailname |
458 | directory is not deleted. | 457 | directory is not deleted. |
459 | .Pp | ||
460 | .Bl -tag -width indent | 458 | .Bl -tag -width indent |
461 | .It Fl f | 459 | .It Fl f |
462 | Stop the jail before deleting it. | 460 | Stop the jail before deleting it. |
@@ -534,9 +532,9 @@ You can set (and override in that order) the retention policy globally in your | |||
534 | .Dq Li $ezjail_default_retention_policy | 532 | .Dq Li $ezjail_default_retention_policy |
535 | .Xr ezjail.conf 5 | 533 | .Xr ezjail.conf 5 |
536 | variable, set them per jail in its config file with their | 534 | variable, set them per jail in its config file with their |
537 | .Dq Li $ezjail_retention_policy | 535 | .Dq Li $ezjail_retention_policy |
538 | variable or set a User property with the name | 536 | variable or set a User property with the name |
539 | .Dq Li ezjail:autosnap_retention | 537 | .Dq Li ezjail:autosnap_retention |
540 | on the respective file systems. | 538 | on the respective file systems. |
541 | .Pp | 539 | .Pp |
542 | The policy is described by a pattern of space separated | 540 | The policy is described by a pattern of space separated |
@@ -557,7 +555,7 @@ Exactly one of the following operand must be specified: | |||
557 | .It Fl b | 555 | .It Fl b |
558 | Build a world from source and install it as the (updated) basejail. | 556 | Build a world from source and install it as the (updated) basejail. |
559 | .Dq make buildworld ; make installworld | 557 | .Dq make buildworld ; make installworld |
560 | by default using the sources located at | 558 | by default using the sources located at |
561 | .Pa /usr/src | 559 | .Pa /usr/src |
562 | (but see the | 560 | (but see the |
563 | .Fl s | 561 | .Fl s |
@@ -574,7 +572,7 @@ recommended to update the basejail along with the host system. | |||
574 | .It Fl u | 572 | .It Fl u |
575 | Use | 573 | Use |
576 | .Xr freebsd-update 8 | 574 | .Xr freebsd-update 8 |
577 | to update the basejail. Note that as | 575 | to update the basejail. Note that as |
578 | .Xr freebsd-update 8 | 576 | .Xr freebsd-update 8 |
579 | uses | 577 | uses |
580 | .Dq Li uname -r | 578 | .Dq Li uname -r |
@@ -649,7 +647,7 @@ filesystem is taken first. | |||
649 | .Xr procfs 5 , | 647 | .Xr procfs 5 , |
650 | .Xr portsnap 8 . | 648 | .Xr portsnap 8 . |
651 | .Sh AUTHOR | 649 | .Sh AUTHOR |
652 | .An Dirk Engling | 650 | .An Dirk Engling |
653 | .Aq erdgeist@erdgeist.org . | 651 | .Aq erdgeist@erdgeist.org . |
654 | .Pp | 652 | .Pp |
655 | The man page is based on a draft by | 653 | The man page is based on a draft by |