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

changeset 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 9b388927b12b
children 738fe7206eab
files docs/conf.py docs/man/index8.rst docs/man/man8/check-ports.rst docs/man/man8/fpkg.rst pkg-plist
diffstat 5 files changed, 200 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/docs/conf.py	Wed Dec 07 01:37:39 2022 +0100
+++ b/docs/conf.py	Wed Dec 07 09:36:30 2022 +0100
@@ -75,6 +75,7 @@
 man_pages = [
     ("man/man8/local-bsdtools", "local-bsdtools", 'FreeBSD administration helper tools v%s' % release, [author], 8),
     ("man/man8/bsmtp2dma", "bsmtp2dma", "Bacula compatible mail submission program", [author], 8),
+    ("man/man8/check-ports", "check-ports", "Report the version status of installed packages and check for them also in repositories", [author], 8),
     ("man/man8/fjail", "fjail", "Management of jails", [author], 8),
     ("man/man8/fjail-configure", "fjail-configure", "Basic configuration of jails", [author], 8),
     #("man/man8/fjail-copy", "fjail-copy", "Recursively copy ZFS datasets including all properties", [author], 8),
--- a/docs/man/index8.rst	Wed Dec 07 01:37:39 2022 +0100
+++ b/docs/man/index8.rst	Wed Dec 07 09:36:30 2022 +0100
@@ -10,6 +10,7 @@
 
    man8/local-bsdtools
    man8/bsmtp2dma
+   man8/check-ports
    man8/fjail
    man8/fjail-configure
    man8/fjail-freebsd-update
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man/man8/check-ports.rst	Wed Dec 07 09:36:30 2022 +0100
@@ -0,0 +1,191 @@
+.. -*- coding: utf-8; indent-tabs-mode: nil; -*-
+
+check-ports
+===========
+
+Synopsis
+--------
+
+**check-ports -hV**
+
+**check-ports** **-n** `package` ...
+
+
+Description
+-----------
+
+Report and check the version status of installed packages and compare
+them to version in remote repositories and the local ports index.
+
+By default (without any option) the status of every package is
+printed with respect to repositories that have the package and have
+differing versions.
+
+.. program:: check-ports
+
+.. option:: -h
+
+   Print a short usage message to stdout and exit.
+
+.. option:: -V
+
+   Print the program name and version number to stdout and exit.
+
+.. option:: -A
+
+   Print for every package the status of all repositories.
+
+.. option:: -a
+
+   Print the data of all repos that have the package.
+
+.. option:: -n
+
+   Print the status of given packages in `package` in all details.
+   No other options are respected.
+
+.. option:: -s
+
+   Print the status of all packages that need some attention.
+
+.. option:: -v
+
+   Print the title and repository of every installed package always.
+
+
+Environment
+-----------
+
+.. envvar:: INDEXDIR
+
+   If set, the directory to search for `INDEXFILE`. If unset,
+   :envvar:`PORTSDIR` will be used instead.
+
+.. envvar:: INDEXFILE
+
+   The filename of the ports index, search for in :envvar:`INDEXDIR` or
+   :envvar:`PORTSDIR`.
+   Default: `INDEX-N` where `N` is the OS major version number.
+
+.. envvar:: PORTSDIR
+
+   Specifies the location to the Ports directory.
+   Default: :file:`/usr/ports`.
+
+
+Files
+-----
+
+:file:`/usr/local/etc/local-bsdtools/package-mapping.conf`
+
+:file:`/usr/local/etc/local-bsdtools/pkgtools.conf`
+
+
+Examples
+--------
+
+Report the status of all installed packages with respect to all configured
+repositories and the ports index (if available)::
+
+   # check-ports -A
+   tdb                                  1.4.3,1           (FreeBSD)
+     INDEX          : 1.4.7,1           < needs updating (index has 1.4.7,1)
+     FreeBSD        : 1.4.7,1           < needs updating (remote has 1.4.7,1)
+     LocalBSDPorts  :                   ?
+     SharedLocalRepo:                   ?
+     LocalRepo      :                   ?
+   teckit                               2.5.11            (FreeBSD)
+     INDEX          : 2.5.11            = up-to-date with index
+     FreeBSD        : 2.5.11            = up-to-date with remote
+     LocalBSDPorts  :                   ?
+     SharedLocalRepo:                   ?
+     LocalRepo      :                   ?
+   tevent                               0.10.2_1          (FreeBSD)
+     INDEX          : 0.13.0_1          < needs updating (index has 0.13.0_1)
+     FreeBSD        : 0.13.0            < needs updating (remote has 0.13.0)
+     LocalBSDPorts  :                   ?
+     SharedLocalRepo:                   ?
+     LocalRepo      :                   ?
+   tex-basic-engines                    20210325          (FreeBSD)
+     INDEX          : 20210325          = up-to-date with index
+     FreeBSD        : 20210325          = up-to-date with remote
+     LocalBSDPorts  :                   ?
+     SharedLocalRepo:                   ?
+     LocalRepo      :                   ?
+   #
+
+Report the status of all installed packages with respect to all configured
+repositories that provide the package::
+
+   # check-ports -a
+   tdb                                  1.4.3,1           (FreeBSD)
+     INDEX          : 1.4.7,1           < needs updating (index has 1.4.7,1)
+     FreeBSD        : 1.4.7,1           < needs updating (remote has 1.4.7,1)
+   teckit                               2.5.11            (FreeBSD)
+     INDEX          : 2.5.11            = up-to-date with index
+     FreeBSD        : 2.5.11            = up-to-date with remote
+   tevent                               0.10.2_1          (FreeBSD)
+     INDEX          : 0.13.0_1          < needs updating (index has 0.13.0_1)
+     FreeBSD        : 0.13.0            < needs updating (remote has 0.13.0)
+   tex-basic-engines                    20210325          (FreeBSD)
+     INDEX          : 20210325          = up-to-date with index
+     FreeBSD        : 20210325          = up-to-date with remote
+   #
+
+The standard output is::
+
+   # check-ports
+   tdb                                  1.4.3,1           (FreeBSD)
+     INDEX          : 1.4.7,1           < needs updating (index has 1.4.7,1)
+     FreeBSD        : 1.4.7,1           < needs updating (remote has 1.4.7,1)
+   tevent                               0.10.2_1          (FreeBSD)
+     INDEX          : 0.13.0_1          < needs updating (index has 0.13.0_1)
+     FreeBSD        : 0.13.0            < needs updating (remote has 0.13.0)
+   #
+
+
+::
+
+   # check-ports -v
+   tdb                                  1.4.3,1           (FreeBSD)
+     INDEX          : 1.4.7,1           < needs updating (index has 1.4.7,1)
+     FreeBSD        : 1.4.7,1           < needs updating (remote has 1.4.7,1)
+   teckit                               2.5.11            (FreeBSD)
+   tevent                               0.10.2_1          (FreeBSD)
+     INDEX          : 0.13.0_1          < needs updating (index has 0.13.0_1)
+     FreeBSD        : 0.13.0            < needs updating (remote has 0.13.0)
+   tex-basic-engines                    20210325          (FreeBSD)
+   #
+
+::
+
+   # check-ports -s
+   tdb                                  1.4.3,1           (FreeBSD)
+     INDEX          : 1.4.7,1           < needs updating (index has 1.4.7,1)
+     FreeBSD        : 1.4.7,1           < needs updating (remote has 1.4.7,1)
+   tevent                               0.10.2_1          (FreeBSD)
+     INDEX          : 0.13.0_1          < needs updating (index has 0.13.0_1)
+     FreeBSD        : 0.13.0            < needs updating (remote has 0.13.0)
+   texlive-base                         20210325_5        (FreeBSD)
+     INDEX          : 20210325_10       < needs updating (index has 20210325_10)
+     FreeBSD        : 20210325_8        < needs updating (remote has 20210325_8)
+   #
+
+::
+
+   # check-ports -sv
+   tdb                                  1.4.3,1           (FreeBSD)
+     INDEX          : 1.4.7,1           < needs updating (index has 1.4.7,1)
+     FreeBSD        : 1.4.7,1           < needs updating (remote has 1.4.7,1)
+   teckit                               2.5.11            (FreeBSD)
+   tevent                               0.10.2_1          (FreeBSD)
+     INDEX          : 0.13.0_1          < needs updating (index has 0.13.0_1)
+     FreeBSD        : 0.13.0            < needs updating (remote has 0.13.0)
+   tex-basic-engines                    20210325          (FreeBSD)
+   #
+
+
+See Also
+--------
+
+:manpage:`fpkg(8)`
--- a/docs/man/man8/fpkg.rst	Wed Dec 07 01:37:39 2022 +0100
+++ b/docs/man/man8/fpkg.rst	Wed Dec 07 09:36:30 2022 +0100
@@ -128,3 +128,9 @@
 
 This configuration file is a Bourne shell (:command:`/bin/sh`)
 compatible file.
+
+
+See Also
+--------
+
+:manpage:`check-ports(8)`
--- a/pkg-plist	Wed Dec 07 01:37:39 2022 +0100
+++ b/pkg-plist	Wed Dec 07 09:36:30 2022 +0100
@@ -8,6 +8,7 @@
 sbin/fzfs
 %%DOCS%%man/man8/local-bsdtools.8.gz
 %%DOCS%%man/man8/bsmtp2dma.8.gz
+%%DOCS%%man/man8/check-ports.8.gz
 %%DOCS%%man/man8/fjail.8.gz
 %%DOCS%%man/man8/fjail-configure.8.gz
 %%DOCS%%man/man8/fjail-freebsd-update.8.gz