Skip to content

Commit 2e3952b

Browse files
Chocimierericonr
authored andcommitted
package-documentation: add section, embrace manpages
1 parent 389e894 commit 2e3952b

File tree

4 files changed

+20
-2
lines changed

4 files changed

+20
-2
lines changed

book.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff 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]
1415
optional = true

src/SUMMARY.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@
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)
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
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`.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ chroot(2) - change root directory
5050

5151
The `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

5555
Development and POSIX manuals are not installed by default, but are available
5656
via the `man-pages-devel` and `man-pages-posix` packages.

0 commit comments

Comments
 (0)