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

comparison docs/man/man8/fpkg.rst @ 321:1f457667f0e7

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