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

comparison docs/man/man8/check-ports.rst @ 349:f98622ae852c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Begin the manual page for check-ports. BUGS: Not yet finished.
author Franz Glasner <fzglas.hg@dom66.de>
date Wed, 07 Dec 2022 09:36:30 +0100
parents
children b15aeca6e433
comparison
equal deleted inserted replaced
348:9b388927b12b 349:f98622ae852c
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
2
3 check-ports
4 ===========
5
6 Synopsis
7 --------
8
9 **check-ports -hV**
10
11 **check-ports** **-n** `package` ...
12
13
14 Description
15 -----------
16
17 Report and check the version status of installed packages and compare
18 them to version in remote repositories and the local ports index.
19
20 By default (without any option) the status of every package is
21 printed with respect to repositories that have the package and have
22 differing versions.
23
24 .. program:: check-ports
25
26 .. option:: -h
27
28 Print a short usage message to stdout and exit.
29
30 .. option:: -V
31
32 Print the program name and version number to stdout and exit.
33
34 .. option:: -A
35
36 Print for every package the status of all repositories.
37
38 .. option:: -a
39
40 Print the data of all repos that have the package.
41
42 .. option:: -n
43
44 Print the status of given packages in `package` in all details.
45 No other options are respected.
46
47 .. option:: -s
48
49 Print the status of all packages that need some attention.
50
51 .. option:: -v
52
53 Print the title and repository of every installed package always.
54
55
56 Environment
57 -----------
58
59 .. envvar:: INDEXDIR
60
61 If set, the directory to search for `INDEXFILE`. If unset,
62 :envvar:`PORTSDIR` will be used instead.
63
64 .. envvar:: INDEXFILE
65
66 The filename of the ports index, search for in :envvar:`INDEXDIR` or
67 :envvar:`PORTSDIR`.
68 Default: `INDEX-N` where `N` is the OS major version number.
69
70 .. envvar:: PORTSDIR
71
72 Specifies the location to the Ports directory.
73 Default: :file:`/usr/ports`.
74
75
76 Files
77 -----
78
79 :file:`/usr/local/etc/local-bsdtools/package-mapping.conf`
80
81 :file:`/usr/local/etc/local-bsdtools/pkgtools.conf`
82
83
84 Examples
85 --------
86
87 Report the status of all installed packages with respect to all configured
88 repositories and the ports index (if available)::
89
90 # check-ports -A
91 tdb 1.4.3,1 (FreeBSD)
92 INDEX : 1.4.7,1 < needs updating (index has 1.4.7,1)
93 FreeBSD : 1.4.7,1 < needs updating (remote has 1.4.7,1)
94 LocalBSDPorts : ?
95 SharedLocalRepo: ?
96 LocalRepo : ?
97 teckit 2.5.11 (FreeBSD)
98 INDEX : 2.5.11 = up-to-date with index
99 FreeBSD : 2.5.11 = up-to-date with remote
100 LocalBSDPorts : ?
101 SharedLocalRepo: ?
102 LocalRepo : ?
103 tevent 0.10.2_1 (FreeBSD)
104 INDEX : 0.13.0_1 < needs updating (index has 0.13.0_1)
105 FreeBSD : 0.13.0 < needs updating (remote has 0.13.0)
106 LocalBSDPorts : ?
107 SharedLocalRepo: ?
108 LocalRepo : ?
109 tex-basic-engines 20210325 (FreeBSD)
110 INDEX : 20210325 = up-to-date with index
111 FreeBSD : 20210325 = up-to-date with remote
112 LocalBSDPorts : ?
113 SharedLocalRepo: ?
114 LocalRepo : ?
115 #
116
117 Report the status of all installed packages with respect to all configured
118 repositories that provide the package::
119
120 # check-ports -a
121 tdb 1.4.3,1 (FreeBSD)
122 INDEX : 1.4.7,1 < needs updating (index has 1.4.7,1)
123 FreeBSD : 1.4.7,1 < needs updating (remote has 1.4.7,1)
124 teckit 2.5.11 (FreeBSD)
125 INDEX : 2.5.11 = up-to-date with index
126 FreeBSD : 2.5.11 = up-to-date with remote
127 tevent 0.10.2_1 (FreeBSD)
128 INDEX : 0.13.0_1 < needs updating (index has 0.13.0_1)
129 FreeBSD : 0.13.0 < needs updating (remote has 0.13.0)
130 tex-basic-engines 20210325 (FreeBSD)
131 INDEX : 20210325 = up-to-date with index
132 FreeBSD : 20210325 = up-to-date with remote
133 #
134
135 The standard output is::
136
137 # check-ports
138 tdb 1.4.3,1 (FreeBSD)
139 INDEX : 1.4.7,1 < needs updating (index has 1.4.7,1)
140 FreeBSD : 1.4.7,1 < needs updating (remote has 1.4.7,1)
141 tevent 0.10.2_1 (FreeBSD)
142 INDEX : 0.13.0_1 < needs updating (index has 0.13.0_1)
143 FreeBSD : 0.13.0 < needs updating (remote has 0.13.0)
144 #
145
146
147 ::
148
149 # check-ports -v
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 teckit 2.5.11 (FreeBSD)
154 tevent 0.10.2_1 (FreeBSD)
155 INDEX : 0.13.0_1 < needs updating (index has 0.13.0_1)
156 FreeBSD : 0.13.0 < needs updating (remote has 0.13.0)
157 tex-basic-engines 20210325 (FreeBSD)
158 #
159
160 ::
161
162 # check-ports -s
163 tdb 1.4.3,1 (FreeBSD)
164 INDEX : 1.4.7,1 < needs updating (index has 1.4.7,1)
165 FreeBSD : 1.4.7,1 < needs updating (remote has 1.4.7,1)
166 tevent 0.10.2_1 (FreeBSD)
167 INDEX : 0.13.0_1 < needs updating (index has 0.13.0_1)
168 FreeBSD : 0.13.0 < needs updating (remote has 0.13.0)
169 texlive-base 20210325_5 (FreeBSD)
170 INDEX : 20210325_10 < needs updating (index has 20210325_10)
171 FreeBSD : 20210325_8 < needs updating (remote has 20210325_8)
172 #
173
174 ::
175
176 # check-ports -sv
177 tdb 1.4.3,1 (FreeBSD)
178 INDEX : 1.4.7,1 < needs updating (index has 1.4.7,1)
179 FreeBSD : 1.4.7,1 < needs updating (remote has 1.4.7,1)
180 teckit 2.5.11 (FreeBSD)
181 tevent 0.10.2_1 (FreeBSD)
182 INDEX : 0.13.0_1 < needs updating (index has 0.13.0_1)
183 FreeBSD : 0.13.0 < needs updating (remote has 0.13.0)
184 tex-basic-engines 20210325 (FreeBSD)
185 #
186
187
188 See Also
189 --------
190
191 :manpage:`fpkg(8)`