Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools

annotate docs/man/man8/fjail.rst @ 649:4ee9a8042f4a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
common.subr: _get_jail_from_path() now just returns when the jail is dying. But it prints the name of the jail if it is yet dying. Real error reporting must not consistently be done in the caller.
author Franz Glasner <fzglas.hg@dom66.de>
date Fri, 27 Sep 2024 21:21:34 +0200
parents 673505e96cea
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
315
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 ftjail
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 ======
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6 Synopsis
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7 --------
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 **fjail -hV**
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11 **fjail subcommand**
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14 Description
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15 -----------
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
16
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
17 Management tool for Jails: creation of ZFS dataset hierarchies, mount,
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
18 population and configuration helpers.
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
19
323
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 315
diff changeset
20 The following global options are implemented:
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 315
diff changeset
21
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 315
diff changeset
22 .. program:: fjail
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 315
diff changeset
23
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 315
diff changeset
24 .. option:: -h
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 315
diff changeset
25
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 315
diff changeset
26 Print a short usage message to stdout and exit.
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 315
diff changeset
27
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 315
diff changeset
28 .. option:: -V
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 315
diff changeset
29
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 315
diff changeset
30 Print the program name and version number to stdout and exit.
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 315
diff changeset
31
315
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
32
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
33 Subcommands
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34 -----------
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36 :manpage:`fjail-configure(8)`
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
38 Do some basic configuration of an already populated and mounted
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
39 jail
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
40
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
41 :manpage:`fjail-copy(8)`
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
42
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
43 Recursively copy ZFS datasets including all properties
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
44
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
45 :manpage:`fjail-datasets(8)`
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
47 Create a new tree of ZFS datasets that will encompass a jail
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
48
347
673505e96cea Implement a "fjail freebsd-update": update "normal" jails and other directories where an OS is mounted
Franz Glasner <hg@dom66.de>
parents: 324
diff changeset
49 :manpage:`fjail-freebsd-update(8)`
673505e96cea Implement a "fjail freebsd-update": update "normal" jails and other directories where an OS is mounted
Franz Glasner <hg@dom66.de>
parents: 324
diff changeset
50
673505e96cea Implement a "fjail freebsd-update": update "normal" jails and other directories where an OS is mounted
Franz Glasner <hg@dom66.de>
parents: 324
diff changeset
51 Do a :manpage:`freebsd-update(8)` with some additional
673505e96cea Implement a "fjail freebsd-update": update "normal" jails and other directories where an OS is mounted
Franz Glasner <hg@dom66.de>
parents: 324
diff changeset
52 compatibility checks
673505e96cea Implement a "fjail freebsd-update": update "normal" jails and other directories where an OS is mounted
Franz Glasner <hg@dom66.de>
parents: 324
diff changeset
53
315
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
54 :manpage:`fjail-hostid(8)`
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
55
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
56 Generate a proposal for a new BSD host UUID and ID
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
57
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
58 :manpage:`fjail-mount(8)`
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
59
324
6bdf954ad93e Man: document that "fjail mount" and "fjail umount" are just aliases of the corresponding "fzfs" commands
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
60 Recursively mount a ZFS dataset and its children.
6bdf954ad93e Man: document that "fjail mount" and "fjail umount" are just aliases of the corresponding "fzfs" commands
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
61
6bdf954ad93e Man: document that "fjail mount" and "fjail umount" are just aliases of the corresponding "fzfs" commands
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
62 It is just an alias for :command:`fzfs mount`
6bdf954ad93e Man: document that "fjail mount" and "fjail umount" are just aliases of the corresponding "fzfs" commands
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
63 (see :manpage:`fzfs-mount(8)`).
315
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
64
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
65 :manpage:`fjail-populate(8)`
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
66
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
67 Populate a directory with content from a FreeBSD base.txz
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
68
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
69 :manpage:`fjail-privs(8)`
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
70
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
71 Adjust some privileges within a mounted jail
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
72
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
73 :manpage:`fjail-umount(8)`
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
74
324
6bdf954ad93e Man: document that "fjail mount" and "fjail umount" are just aliases of the corresponding "fzfs" commands
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
75 Recursively unmount a ZFS datasets and its children.
6bdf954ad93e Man: document that "fjail mount" and "fjail umount" are just aliases of the corresponding "fzfs" commands
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
76
6bdf954ad93e Man: document that "fjail mount" and "fjail umount" are just aliases of the corresponding "fzfs" commands
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
77 It is just an alias for :command:`fzfs umount`
6bdf954ad93e Man: document that "fjail mount" and "fjail umount" are just aliases of the corresponding "fzfs" commands
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
78 (see :manpage:`fzfs-umount(8)`).
315
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
79
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
80
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
81 Implementation Notes
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
82 --------------------
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
83
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
84 Some commands require ZFS as filesystem.
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
85
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
86 Some commands are suitable for Thin Jails also.
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
87
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
88
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
89 Environment
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
90 -----------
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
91
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
92 All environment variables that affect :command:`zfs` are effective also.