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

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 f98622ae852c
children bda643a6310e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
321
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 fpkg
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 ====
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6 Synopsis
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7 --------
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 **fpkg -hV**
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11 **fpkg subcommand**
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14 Description
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15 -----------
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
16
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
17 A :manpage:`pkg(8)` frontend for common operations that also operates
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
18 in all running and compatible jails.
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
19
322
08d67640721b Man: Reorder paragraph in the "Description" section
Franz Glasner <fzglas.hg@dom66.de>
parents: 321
diff changeset
20 A "compatible jail" is a jail that's output of
08d67640721b Man: Reorder paragraph in the "Description" section
Franz Glasner <fzglas.hg@dom66.de>
parents: 321
diff changeset
21 :command:`freebsd-version -u` is the same as the host's.
08d67640721b Man: Reorder paragraph in the "Description" section
Franz Glasner <fzglas.hg@dom66.de>
parents: 321
diff changeset
22
321
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
23 The following global options are implemented:
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
24
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
25 .. program:: fpkg
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
26
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
27 .. option:: -h
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
28
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
29 Print a short usage message to stdout and exit.
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
30
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
31 .. option:: -V
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
32
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
33 Print the program name and version number to stdout and exit.
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36 Subcommands
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37 -----------
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
38
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
39 :manpage:`fpkg-audit(8)`
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
40
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
41 Call :command:`pkg audit` on the local host and all running
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
42 visible and compatible jails.
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
43
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
44 :manpage:`fpkg-check-fast-track(8)`
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
45
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46 Check packages installed from the LocalBSDPorts repository against
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
47 the repositories `FreeBSD` and `LocalBSDPorts` on the local host
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
48 and all visible and compatible jails
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
49
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
50 :manpage:`fpkg-check-upgrade(8)`
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
51
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
52 Call :command:`pkg upgrade -n` on the local host and all running
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
53 visible and compatible jails.
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
54
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
55 :manpage:`fpkg-config(8)`
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
56
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
57 Retrieve the value of a given :manpage:`pkg(8)` configuration
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
58 option on the local host and all running visible and
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
59 compatible jails (:command:`pkg config`).
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
60
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
61 :manpage:`fpkg-update(8)`
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
62
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
63 Call :command:`pkg update` on the local host and all running
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
64 visible and compatible jails.
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
65
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
66 :manpage:`fpkg-upgrade(8)`
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
67
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
68 Call :command:`pkg upgrade` on the local host and all running
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
69 visible and compatible jails.
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
70
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
71 :manpage:`fpkg-uversion(8)`
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
72
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
73 Call :command:`freebsd-version -u` on the local host and all
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
74 running visible and compatible jails.
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
75
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
76 :manpage:`fpkg-vv(8)`
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
77
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
78 Call :command:`pkg -vv` on the local host and all running visible
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
79 and compatible jails.
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
80
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
81
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
82 Environment
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
83 -----------
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
84
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
85 .. envvar:: FPKG_AUDIT_FLAGS
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
86
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
87 Additional flags given to :command:`pkg audit` (Default: ``-Fr``).
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
88
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
89 .. envvar:: FPKG_UPDATE_FLAGS
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
90
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
91 Additional flags given to :command:`pkg update` (Default: empty).
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
92
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
93 .. envvar:: FPKG_UPGRADE_FLAGS
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
94
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
95 Additional flags given to :command:`pkg upgrade` and
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
96 :command:`pkg upgrade -n` (Default: empty).
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
97
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
98 .. envvar:: FPKG_SIGN
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
99
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
100 Marker for the begin of an output group (local host or jail)
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
101 (Default: "===> ").
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
102
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
103 .. envvar:: FPKG_SKIPSIGN
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
104
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
105 Marker for the begin of a skipped output group (Default: "----> ").
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
106
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
107 .. envvar:: FREEBSD_REPO
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
108
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
109 The name of the (official) FreeBSD package repository (Default:
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
110 ``FreeBSD``).
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
111
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
112 .. envvar:: LOCALBSDPORTS_REPO
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
113
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
114 Repository with ports with default port OPTIONS (i.e. unchanged)
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
115 but with newer package versions as the "FreeBSD" repository. Some sort
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
116 of fast-track repository.
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
117
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
118 All other environment variables that affect :manpage:`pkg(8)` are
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
119 effective also.
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
120
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
121
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
122 Files
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
123 -----
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
124
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
125 If there is a :file:`/usr/local/etc/local-bsdtools/pkgtools.conf` then
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
126 this file is sourced in. All environment variables that are documented
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
127 in `Environment`_ can be set in this file also.
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
128
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
129 This configuration file is a Bourne shell (:command:`/bin/sh`)
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
130 compatible file.
349
f98622ae852c Begin the manual page for check-ports.
Franz Glasner <fzglas.hg@dom66.de>
parents: 322
diff changeset
131
f98622ae852c Begin the manual page for check-ports.
Franz Glasner <fzglas.hg@dom66.de>
parents: 322
diff changeset
132
f98622ae852c Begin the manual page for check-ports.
Franz Glasner <fzglas.hg@dom66.de>
parents: 322
diff changeset
133 See Also
f98622ae852c Begin the manual page for check-ports.
Franz Glasner <fzglas.hg@dom66.de>
parents: 322
diff changeset
134 --------
f98622ae852c Begin the manual page for check-ports.
Franz Glasner <fzglas.hg@dom66.de>
parents: 322
diff changeset
135
f98622ae852c Begin the manual page for check-ports.
Franz Glasner <fzglas.hg@dom66.de>
parents: 322
diff changeset
136 :manpage:`check-ports(8)`