view docs/man/man5/package-mapping.conf.rst @ 738:6420368517d5

Docs: comments are allowed in package-mapping.conf now
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 07 Oct 2024 17:30:10 +0200
parents 6501f942f271
children 56ab5c012d5f
line wrap: on
line source

.. -*- coding: utf-8; indent-tabs-mode: nil; -*-

package-mapping.conf
====================

Description
-----------

Used by :manpage:`check-ports(8)`.

This is a textfile where every line contains two fields -- separated by
white space (TAB or SPACE). Each field is a package name::

    installed-package-name  original-package-name

When :command:`check-ports` determines the package status for
`installed-package-name` then the repositories are checked with regard to
`original-package-name` also.

This is useful when the update status of renamed (private) forks (with
`installed-package-name`) should be checked against the original
parent package (with name `original-package-name`) also.

Empty lines and lines starting with ``#`` are treated as a comment.


Examples
--------

Assume that package ``pack-orig`` is forked into a local package with
a different name ``my-forked-pack``. To let the tools :command:`check-ports`
and :command:`fports` to take this into account use::

    my-forked-pack pack-orig

    # my-commented-out-pack other-pack-orig


See Also
--------