Metadata-Version: 2.1
Name: pnu-libmanconf
Version: 1.1.2
Summary: library for handling man(1) and manpath(1) configuration files
Home-page: https://github.com/HubTou/libmanconf/
Author: Hubert Tournier
Author-email: nobody@nowhere.invalid
License: BSD 3-Clause License
Project-URL: Bug Tracker, https://github.com/HubTou/libmanconf/issues
Keywords: pnu-project
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Operating System :: POSIX :: BSD :: FreeBSD
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.0
Description-Content-Type: text/markdown
License-File: License

# Installation
pip install [pnu-libmanconf](https://pypi.org/project/pnu-libmanconf/)

# LIBMANCONF(3)

## NAME
libmanconf — library for handling man(1) and manpath(1) configuration files

## SYNOPSIS
import **libmanconf**

String, String, List *libmanconf*.**read_man_conf_files**(Integer *debug_level* = 0, String *manpath_so_far* = '')

## DESCRIPTION
The **read_man_conf_files()** function reads the configuration files located at "/etc/man.conf" and "/usr/local/etc/man.d/\*.conf"
to configure the manual search path, locales and utility set used by man(1) and related utilities.

The function takes an optional argument *debug_level* with an integer value from 0 (default) to 3,
to print increasingly detailed information on standard error output.

It can also take another optional argument *manpath_so_far* with a colon separated string of already added directories to the manual path,
in order to check for duplicate entries.

It returns a triplet consisting of:
* a string containing colon separated existing MANPATH directories
* a string containing colon separated locales (for example, "fr_FR.UTF-8:ja_JP.eucJP")
* a list containing processors (for example, \["TBL_JA=/usr/local/bin/gtbl", "NROFF_JA=/usr/local/bin/groff -man -dlang=ja_JP.eucJP"\])

## SEE ALSO
[apropos(1)](https://www.freebsd.org/cgi/man.cgi?query=apropos&sektion=1),
[man(1)](https://www.freebsd.org/cgi/man.cgi?query=man&sektion=1),
[man.conf(5)](https://www.freebsd.org/cgi/man.cgi?query=man.conf&sektion=5),
[manpath(1)](https://www.freebsd.org/cgi/man.cgi?query=manpath&sektion=1),
[whatis(1)](https://www.freebsd.org/cgi/man.cgi?query=whatis&sektion=1)

## STANDARDS
The **libmanconf** library is not a standard UNIX one.

It tries to follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide for [Python](https://www.python.org/) code.

## PORTABILITY
To be tested under Windows.

## HISTORY
This library was made for the [PNU project](https://github.com/HubTou/PNU) to factor code for the man(1) and manpath(1) commands.

## LICENSE
It is available under the [3-clause BSD license](https://opensource.org/licenses/BSD-3-Clause).

## AUTHORS
[Hubert Tournier](https://github.com/HubTou)

The man.conf(5) manual page is largely based on the one written for [FreeBSD](https://www.freebsd.org/) by [Gordon Tetlow](https://github.com/tetlowgm).



