diff docs/man/man8/fports.rst @ 814:2310764e5c4e

fports: Implement a global "--jail/-j" option: execute the fports commands in a jail. The jail just needs to have an installed "pkg" command.
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 09 Nov 2024 00:47:05 +0100
parents a59cc4bea000
children
line wrap: on
line diff
--- a/docs/man/man8/fports.rst	Fri Nov 08 12:57:59 2024 +0100
+++ b/docs/man/man8/fports.rst	Sat Nov 09 00:47:05 2024 +0100
@@ -13,9 +13,9 @@
 
 **fports**  **-V**\|\ **--version**
 
-**fports deptree** [**-l** `maxlevel`\|\ **--maxlevel**\=\ `maxlevel`] [**-r**\|\ **--reverse**] [**-t**\|\ **--list**\|\ **--transitive**] `package` ...
+**fports** [**-j** `jail`\|\ **--jail**\=\ `jail`] **deptree** [**-l** `maxlevel`\|\ **--maxlevel**\=\ `maxlevel`] [**-r**\|\ **--reverse**] [**-t**\|\ **--list**\|\ **--transitive**] `package` ...
 
-**fports detail**  [**-A**] [**-b**\|\ **--nofreebsd**\|\ **--no-freebsd**] [**-f**\ |\ **--filter-unused**] [**-n**\|\ **--noauto**\|\ **--no-auto**] [**-m**\|\ **--mapped**] [`package` ...]
+**fports** [**-j** `jail`\|\ **--jail**\=\ `jail`] **detail** [**-A**] [**-b**\|\ **--nofreebsd**\|\ **--no-freebsd**] [**-f**\ |\ **--filter-unused**] [**-n**\|\ **--noauto**\|\ **--no-auto**] [**-m**\|\ **--mapped**] [`package` ...]
 
 
 Description
@@ -33,6 +33,18 @@
 This tools is the successor of :manpage:`check-ports(8)`.
 
 
+Global Options
+--------------
+
+These global options are implemented for all subcommands:
+
+.. option:: -j <name_or_id>, --jail=<name_or_id>
+
+   The script will execute in the given jail `name or id`, where name
+   matches :command:`jls name` and id matches :command:`jls jid`.
+   See  :manpage:`jail(8)`  and :manpage:`jls(8)`.
+
+
 Subcommands
 -----------
 
@@ -47,7 +59,7 @@
    Print the program name and version number to stdout and exit.
 
 
-**fports deptree** [**-l** `maxlevel`\|\ **--maxlevel**\=\ `maxlevel`] [**-r**\|\ **--reverse**] [**-t**\|\ **--list**\|\ **--transitive**] `package` ...
+**fports** [**-j** `jail`\|\ **--jail**\=\ `jail`] **deptree** [**-l** `maxlevel`\|\ **--maxlevel**\=\ `maxlevel`] [**-r**\|\ **--reverse**] [**-t**\|\ **--list**\|\ **--transitive**] `package` ...
 
   Print a dependency tree for every given `package`. A package tree is
   a hierarchical list of packages that `packages` depends on.
@@ -71,7 +83,7 @@
      that depend on a given `package`.
 
 
-**fports detail**  [**-A**] [**-b**\|\ **--nofreebsd**\|\ **--no-freebsd**] [**-f**\ |\ **--filter-unused**] [**-n**\|\ **--noauto**\|\ **--no-auto**] [**-m**\|\ **--mapped**] [`package` ...]
+**fports** [**-j** `jail`\|\ **--jail**\=\ `jail`] **detail**  [**-A**] [**-b**\|\ **--nofreebsd**\|\ **--no-freebsd**] [**-f**\ |\ **--filter-unused**] [**-n**\|\ **--noauto**\|\ **--no-auto**] [**-m**\|\ **--mapped**] [`package` ...]
 
   Print the status of all given or selected packages in the most
   detail possible.