NAME

void-docs — Access Void Linux documentation

SYNOPSIS

DESCRIPTION

The 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) or sk(1) utilities installed in their system, it will be used to browse the results. Otherwise, void-docs will immediately display the first search result. If the -s flag is used, void-docs will display the search results instead of the documentation.

The programs void-docs will try to use are, in order of preference:

• For the HTML version:
  • the program specified in the environment variable BROWSER.
  • xdg-open(1) if either the DISPLAY or WAYLAND_DISPLAY environment variable is set.
  • run-mailcap(1).
  • the TUI browsers lynx(1), w3m(1), and links(1).
• For the Markdown version:
  • the Markdown processors ‘mdcat’ and ‘glow’.
• For the roff (mdoc) version:
  • man(1).
• For the PDF version:
  • xdg-open(1), and run-mailcap(1).
  • the PDF viewers zathura(1) and okular(1).

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.

OPTIONS

-h, --help

Show help message.

-b

Only try to display the HTML version.

-m

Only try to display the Markdown version.

-r

Only try to display the roff (mdoc) version.

-p

Open the PDF version.

-s

Only display search results.

FILES

The ‘void-docs’ package contains a snapshot of the online documentation from https://docs.voidlinux.org, which intends to document installation, configuration and system management for Void Linux. It is packaged in four formats.

/usr/share/doc/void/html

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 browser to /usr/share/doc/void/html/index.html.

/usr/share/doc/void/markdown

Documentation in Markdown format. Can be viewed as text files, using cat(1) or less(1), or as formatted Markdown files, using applications such as ‘mdcat’ or ‘glow’. The table of contents can be accessed via the /usr/share/doc/void/markdown/SUMMARY.md file.

/usr/share/doc/void/mandoc

Documentation in roff (mdoc) format. Can be viewed using mandoc(1). Using mandoc(1) with the -a option, which enables a pager, is recommended.

/usr/share/doc/void/handbook.pdf

Documentation in PDF format. Can be viewed with any PDF viewer, such as zathura(1) or okular(1).

EXAMPLES

View the documentation page about the kernel:

View a documentation page inside another session:

View the homepage of the HTML documentation with qutebrowser(1):

View the summary of the Markdown documentation with less(1):

View the “Kernel” page of the Markdown documentation with ‘mdcat’:

View the “Cron” page of the roff (mdoc) documentation with mandoc(1):

AVAILABILITY

This man page is part of the void-docs package and is available from https://github.com/void-linux/void-docs.

BUGS

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 https://github.com/void-linux/void-docs.