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

annotate docs/man/man5/package-mapping.conf.rst @ 712:6501f942f271

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Man for package-mapping.conf: FIX: Order of fields was documented wrongly. While there: also enhance the wording of some paragraphs.
author Franz Glasner <fzglas.hg@dom66.de>
date Thu, 03 Oct 2024 19:52:23 +0200
parents 6a80de5a67ca
children 6420368517d5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
409
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 package-mapping.conf
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 ====================
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6 Description
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7 -----------
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 Used by :manpage:`check-ports(8)`.
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10
712
6501f942f271 Man for package-mapping.conf: FIX: Order of fields was documented wrongly.
Franz Glasner <fzglas.hg@dom66.de>
parents: 413
diff changeset
11 This is a textfile where every line contains two fields -- separated by
6501f942f271 Man for package-mapping.conf: FIX: Order of fields was documented wrongly.
Franz Glasner <fzglas.hg@dom66.de>
parents: 413
diff changeset
12 white space (TAB or SPACE). Each field is a package name::
410
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
13
712
6501f942f271 Man for package-mapping.conf: FIX: Order of fields was documented wrongly.
Franz Glasner <fzglas.hg@dom66.de>
parents: 413
diff changeset
14 installed-package-name original-package-name
410
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
15
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
16 When :command:`check-ports` determines the package status for
712
6501f942f271 Man for package-mapping.conf: FIX: Order of fields was documented wrongly.
Franz Glasner <fzglas.hg@dom66.de>
parents: 413
diff changeset
17 `installed-package-name` then the repositories are checked with regard to
6501f942f271 Man for package-mapping.conf: FIX: Order of fields was documented wrongly.
Franz Glasner <fzglas.hg@dom66.de>
parents: 413
diff changeset
18 `original-package-name` also.
410
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
19
712
6501f942f271 Man for package-mapping.conf: FIX: Order of fields was documented wrongly.
Franz Glasner <fzglas.hg@dom66.de>
parents: 413
diff changeset
20 This is useful when the update status of renamed (private) forks (with
6501f942f271 Man for package-mapping.conf: FIX: Order of fields was documented wrongly.
Franz Glasner <fzglas.hg@dom66.de>
parents: 413
diff changeset
21 `installed-package-name`) should be checked against the original
6501f942f271 Man for package-mapping.conf: FIX: Order of fields was documented wrongly.
Franz Glasner <fzglas.hg@dom66.de>
parents: 413
diff changeset
22 parent package (with name `original-package-name`) also.
410
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
23
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
24
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
25 Examples
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
26 --------
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
27
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
28 Assume that package ``pack-orig`` is forked into a local package with
712
6501f942f271 Man for package-mapping.conf: FIX: Order of fields was documented wrongly.
Franz Glasner <fzglas.hg@dom66.de>
parents: 413
diff changeset
29 a different name ``my-forked-pack``. To let the tools :command:`check-ports`
6501f942f271 Man for package-mapping.conf: FIX: Order of fields was documented wrongly.
Franz Glasner <fzglas.hg@dom66.de>
parents: 413
diff changeset
30 and :command:`fports` to take this into account use::
410
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
31
712
6501f942f271 Man for package-mapping.conf: FIX: Order of fields was documented wrongly.
Franz Glasner <fzglas.hg@dom66.de>
parents: 413
diff changeset
32 my-forked-pack pack-orig
410
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
33
409
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35 See Also
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36 --------
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
38 :manpage:`check-ports(8)`
410
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
39
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
40
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
41 Bugs
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
42 ----
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
43
6604ceca9d1d Manual pages: package-mapping.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
44 Comments in the file are currently not allowed.