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

comparison docs/man/man8/fports.rst @ 770:56ab5c012d5f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fports: Begin a new command "fports" and fully implemented its subcommand "fports deptree". fports is supposed to be the successor to check-ports.
author Franz Glasner <fzglas.hg@dom66.de>
date Wed, 23 Oct 2024 13:56:52 +0200
parents
children b5b19c62da24
comparison
equal deleted inserted replaced
769:03350d2a2af6 770:56ab5c012d5f
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
2
3 fports
4 ======
5
6 .. program:: fports
7
8
9 Synopsis
10 --------
11
12 **fports -h**
13
14 **fports -V**
15
16 **fports subcommand**
17
18
19 Description
20 -----------
21
22 Report and check the version status of installed packages and compare
23 them to version in remote repositories and the local ports index.
24
25 By default (without any option) the status of every package is
26 printed with respect to repositories that have the package and have
27 differing versions. This includes the ports INDEX.
28
29 :command:`fpkg` provides some subcommands.
30
31 This tools is the successor of :manpage:`check-ports(8)`.
32
33
34 Subcommands
35 -----------
36
37 These global options are implemented:
38
39 .. option:: -h
40
41 Print a short usage message to stdout and exit.
42
43 .. option:: -V
44
45 Print the program name and version number to stdout and exit.
46
47
48 **fports deptree** `package`...
49
50 Print a dependency tree for every given `package`. A package tree is
51 a hierarchical list of packages that `packages` depends on.
52
53 .. program:: fports deptree
54
55 .. option:: -l <maxlevel>
56
57 Limit the output to sub-levels up to `maxlevel`. To print only
58 direct dependencies use a `maxlevel` of `1`.
59 Default is 0 (i.e. no limit).
60
61 .. option:: -r
62
63 Use reversed dependencies and print the package tree for all packages
64 that depend on a given `package`.
65
66
67 Environment
68 -----------
69
70 .. envvar:: INDEXDIR
71
72 If set, the directory to search for `INDEXFILE`. If unset,
73 :envvar:`PORTSDIR` will be used instead.
74
75 .. envvar:: INDEXFILE
76
77 The filename of the ports index, search for in :envvar:`INDEXDIR` or
78 :envvar:`PORTSDIR`.
79 Default: `INDEX-<N>` where `N` is the OS major version number.
80
81 .. envvar:: PORTSDIR
82
83 Specifies the location to the Ports directory.
84 Default: :file:`/usr/ports`.
85
86
87 Files
88 -----
89
90 :file:`/usr/local/etc/local-bsdtools/package-mapping.conf`
91
92 :file:`/usr/local/etc/local-bsdtools/pkgtools.conf`
93
94
95 Examples
96 --------
97
98 Report the status of all installed packages with respect to all configured
99 repositories and the ports index (if available)::
100
101 # check-ports -A
102 tdb 1.4.3,1 (FreeBSD)
103 INDEX : 1.4.7,1 < needs updating (index has 1.4.7,1)
104 FreeBSD : 1.4.7,1 < needs updating (remote has 1.4.7,1)
105 LocalBSDPorts : ?
106 SharedLocalRepo: ?
107 LocalRepo : ?
108 teckit 2.5.11 (FreeBSD)
109 INDEX : 2.5.11 = up-to-date with index
110 FreeBSD : 2.5.11 = up-to-date with remote
111 LocalBSDPorts : ?
112 SharedLocalRepo: ?
113 LocalRepo : ?
114 tevent 0.10.2_1 (FreeBSD)
115 INDEX : 0.13.0_1 < needs updating (index has 0.13.0_1)
116 FreeBSD : 0.13.0 < needs updating (remote has 0.13.0)
117 LocalBSDPorts : ?
118 SharedLocalRepo: ?
119 LocalRepo : ?
120 tex-basic-engines 20210325 (FreeBSD)
121 INDEX : 20210325 = up-to-date with index
122 FreeBSD : 20210325 = up-to-date with remote
123 LocalBSDPorts : ?
124 SharedLocalRepo: ?
125 LocalRepo : ?
126 #
127
128 Report the status of all installed packages with respect to all configured
129 repositories that provide the package::
130
131 # check-ports -a
132 tdb 1.4.3,1 (FreeBSD)
133 INDEX : 1.4.7,1 < needs updating (index has 1.4.7,1)
134 FreeBSD : 1.4.7,1 < needs updating (remote has 1.4.7,1)
135 teckit 2.5.11 (FreeBSD)
136 INDEX : 2.5.11 = up-to-date with index
137 FreeBSD : 2.5.11 = up-to-date with remote
138 tevent 0.10.2_1 (FreeBSD)
139 INDEX : 0.13.0_1 < needs updating (index has 0.13.0_1)
140 FreeBSD : 0.13.0 < needs updating (remote has 0.13.0)
141 tex-basic-engines 20210325 (FreeBSD)
142 INDEX : 20210325 = up-to-date with index
143 FreeBSD : 20210325 = up-to-date with remote
144 #
145
146 The standard output considers installed packages with versions that differ in any of
147 the configured repositories *including* a ports INDEX::
148
149 # check-ports
150 tdb 1.4.3,1 (FreeBSD)
151 INDEX : 1.4.7,1 < needs updating (index has 1.4.7,1)
152 FreeBSD : 1.4.7,1 < needs updating (remote has 1.4.7,1)
153 tevent 0.10.2_1 (FreeBSD)
154 INDEX : 0.13.0_1 < needs updating (index has 0.13.0_1)
155 FreeBSD : 0.13.0 < needs updating (remote has 0.13.0)
156 tex-xetex 0.99993_1 (FreeBSD)
157 INDEX : 0.99993_2 < needs updating (index has 0.99993_2)
158 FreeBSD : 0.99993_1 = up-to-date with remote
159 texlive-base 20210325_5 (FreeBSD)
160 INDEX : 20210325_10 < needs updating (index has 20210325_10)
161 FreeBSD : 20210325_8 < needs updating (remote has 20210325_8)
162 #
163
164 The effect of an additional :option:`-v` on :command:`check-ports` is::
165
166 # check-ports -v
167 tdb 1.4.3,1 (FreeBSD)
168 INDEX : 1.4.7,1 < needs updating (index has 1.4.7,1)
169 FreeBSD : 1.4.7,1 < needs updating (remote has 1.4.7,1)
170 teckit 2.5.11 (FreeBSD)
171 tevent 0.10.2_1 (FreeBSD)
172 INDEX : 0.13.0_1 < needs updating (index has 0.13.0_1)
173 FreeBSD : 0.13.0 < needs updating (remote has 0.13.0)
174 tex-basic-engines 20210325 (FreeBSD)
175 tex-dvipdfmx 20210325 (FreeBSD)
176 tex-dvipsk 2021.1 (FreeBSD)
177 tex-formats 20210325_1 (FreeBSD)
178 tex-jadetex 3.13_4 (FreeBSD)
179 tex-kpathsea 6.3.3 (FreeBSD)
180 tex-libtexlua 5.3.6 (FreeBSD)
181 tex-libtexluajit 2.1.0 (FreeBSD)
182 tex-luatex 1.12.0 (FreeBSD)
183 tex-ptexenc 1.3.9 (FreeBSD)
184 tex-synctex 2.0.0_1 (FreeBSD)
185 tex-web2c 20210325 (FreeBSD)
186 tex-xdvik 22.87.06 (FreeBSD)
187 tex-xetex 0.99993_1 (FreeBSD)
188 INDEX : 0.99993_2 < needs updating (index has 0.99993_2)
189 FreeBSD : 0.99993_1 = up-to-date with remote
190 tex-xmltex 1.9_3 (FreeBSD)
191 texlive-base 20210325_5 (FreeBSD)
192 INDEX : 20210325_10 < needs updating (index has 20210325_10)
193 FreeBSD : 20210325_8 < needs updating (remote has 20210325_8)
194 #
195
196 The :option:`-s` suppresses the output if only the version of a ports INDEX differs::
197
198 # check-ports -s
199 tdb 1.4.3,1 (FreeBSD)
200 INDEX : 1.4.7,1 < needs updating (index has 1.4.7,1)
201 FreeBSD : 1.4.7,1 < needs updating (remote has 1.4.7,1)
202 tevent 0.10.2_1 (FreeBSD)
203 INDEX : 0.13.0_1 < needs updating (index has 0.13.0_1)
204 FreeBSD : 0.13.0 < needs updating (remote has 0.13.0)
205 texlive-base 20210325_5 (FreeBSD)
206 INDEX : 20210325_10 < needs updating (index has 20210325_10)
207 FreeBSD : 20210325_8 < needs updating (remote has 20210325_8)
208 #
209
210 The effect of an additional :option:`-v` on :command:`checkports -s` is::
211
212 # check-ports -sv
213 tdb 1.4.3,1 (FreeBSD)
214 INDEX : 1.4.7,1 < needs updating (index has 1.4.7,1)
215 FreeBSD : 1.4.7,1 < needs updating (remote has 1.4.7,1)
216 teckit 2.5.11 (FreeBSD)
217 tevent 0.10.2_1 (FreeBSD)
218 INDEX : 0.13.0_1 < needs updating (index has 0.13.0_1)
219 FreeBSD : 0.13.0 < needs updating (remote has 0.13.0)
220 tex-basic-engines 20210325 (FreeBSD)
221 tex-dvipdfmx 20210325 (FreeBSD)
222 tex-dvipsk 2021.1 (FreeBSD)
223 tex-formats 20210325_1 (FreeBSD)
224 tex-jadetex 3.13_4 (FreeBSD)
225 tex-kpathsea 6.3.3 (FreeBSD)
226 tex-libtexlua 5.3.6 (FreeBSD)
227 tex-libtexluajit 2.1.0 (FreeBSD)
228 tex-luatex 1.12.0 (FreeBSD)
229 tex-ptexenc 1.3.9 (FreeBSD)
230 tex-synctex 2.0.0_1 (FreeBSD)
231 tex-web2c 20210325 (FreeBSD)
232 tex-xdvik 22.87.06 (FreeBSD)
233 tex-xetex 0.99993_1 (FreeBSD)
234 tex-xmltex 1.9_3 (FreeBSD)
235 texlive-base 20210325_5 (FreeBSD)
236 INDEX : 20210325_10 < needs updating (index has 20210325_10)
237 FreeBSD : 20210325_8 < needs updating (remote has 20210325_8)
238 #
239
240
241 See Also
242 --------
243
244 :manpage:`fpkg(8)`, :manpage:`check-ports(8)`,
245 :manpage:`pkgtools.conf(5)`, :manpage:`package-mapping.conf(5)`