Access Void Linux documentation
|[OPTIONS] [search terms]
TABLE OF CONTENTS
void-docs utility will attempt to launch different
programs until it can find an adequate one to display the Void Linux
documentation. If it is invoked without a search term, it will show the
documentation's home page. Multiple search terms can be used to filter
results. If the user has the fzf(1) utility
installed in their system, it will be used to browse the results. Otherwise,
void-docs will display the first search result. If the
-s flag is used,
will display the search results instead of the documentation.
void-docs will try to use
are, in order of preference:
- For the HTML version:
- For the Markdown version:
- the Markdown processors ‘mdcat’ and
- For the roff (mdoc) version:
- For the PDF version:
It should be noted that for the PDF version,
void-docs doesn't support search results.
For a better browsing experience, installing
fzf(1) is recommended.
The ‘void-docs’ package contains a snapshot of the online
which intends to document installation, configuration and system management
for Void Linux. It is packaged in four formats.
- Show help message.
- Only try to display the HTML version.
- Only try to display the Markdown version.
- Only try to display the roff (mdoc) version.
- Open the PDF version.
- Only display search results.
View the documentation page about the kernel:
- Documentation in HTML format. Can be viewed with any browser, such as
Mozilla Firefox or Chromium. Recommended when a GUI session is available,
because it allows easy navigation between the documentation pages and has
the same format as the official website. Can be accessed by pointing a
- Documentation in Markdown format. Can be viewed as text files, using
less(1), or as formatted Markdown files,
using applications such as ‘mdcat’ or ‘glow’.
The table of contents can be accessed via the
- Documentation in roff (mdoc) format. Can be viewed using
mandoc(1) with the
-a option, which enables a pager, is
- Documentation in PDF format. Can be viewed with any PDF viewer, such as
$ void-docs kernel
View a documentation page inside another session:
$ void-docs graphical-session
View the homepage of the HTML documentation with
View the summary of the Markdown documentation with
View the “Kernel” page of the Markdown documentation
View the “Cron” page of the roff (mdoc)
documentation with mandoc(1):
The Void Linux documentation tries to limit itself to content that is specific
to Void. Therefore, if you feel something is missing, it might have been
deliberate. However, if there is any information that is mistaken, outdated or
indeed missing, please report an issue at
$ mandoc -a