File tree Expand file tree Collapse file tree 4 files changed +20
-2
lines changed
config/package-documentation Expand file tree Collapse file tree 4 files changed +20
-2
lines changed Original file line number Diff line number Diff line change @@ -9,6 +9,7 @@ theme = "src/theme"
99
1010[output .html .redirect ]
1111"/about-this-handbook.html" = " /about/about-this-handbook.html"
12+ "/config/man.html" = " /config/package-documentation/man.html"
1213
1314[output .latex ]
1415optional = true
Original file line number Diff line number Diff line change 1616 - [ Supported Platforms] ( ./installation/guides/arm-devices/platforms.md )
1717 - [ musl] ( ./installation/musl.md )
1818- [ Configuration] ( ./config/index.md )
19- - [ Manual Pages] ( ./config/man.md )
19+ - [ Package Documentation] ( ./config/package-documentation/index.md )
20+ - [ Manual Pages] ( ./config/package-documentation/man.md )
2021 - [ Firmware] ( ./config/firmware.md )
2122 - [ Locales and Translations] ( ./config/locales.md )
2223 - [ Users and Groups] ( ./config/users-and-groups.md )
Original file line number Diff line number Diff line change 1+ # Package documentation
2+
3+ The most common media for documentation in Void Linux are [ manual
4+ pages] ( ./man.md ) .
5+
6+ Many packages contain documentation in other formats, like HTML. This
7+ documentation can usually be found in a ` /usr/share/doc/<package> ` directory.
8+
9+ More extensive documentation may be split into separate ` *-doc ` packages, such
10+ as ` julia-doc ` . This is often the case for programming languages, databases and
11+ big software libraries.
12+
13+ In addition to documentation provided by upstream projects, packages may also
14+ contain description of initial setup or usage specific to Void, provided by
15+ distribution contributors. It will be located in
16+ ` /usr/share/doc/<package>/README.voidlinux ` .
Original file line number Diff line number Diff line change @@ -50,7 +50,7 @@ chroot(2) - change root directory
5050
5151The ` mdocml ` package provides a cron job to update the database daily,
5252` /etc/cron.daily/makewhatis ` . You will need to install a [ cron
53- daemon] ( ./cron.md ) for this functionality to be activated.
53+ daemon] ( .. /cron.md ) for this functionality to be activated.
5454
5555Development and POSIX manuals are not installed by default, but are available
5656via the ` man-pages-devel ` and ` man-pages-posix ` packages.
You can’t perform that action at this time.
0 commit comments