11# Manual Pages
22
3- Void packages come with manual pages and the default installation includes the
4- [ mandoc] ( https://mandoc.bsd.lv/ ) manpage toolset.
3+ Many Void packages come with manual ('man') pages. The default installation
4+ includes the [ mandoc] ( https://mandoc.bsd.lv/ ) manpage toolset, via the ` mdocml `
5+ package.
56
6- The [ man(1)] ( https://man.voidlinux.org/man.1 ) command can be used to show manual
7- pages.
7+ The [ man(1)] ( https://man.voidlinux.org/man.1 ) command can be used to show man
8+ pages:
89
910```
10- $ man 1 chroot
11+ $ man chroot
1112```
1213
14+ Every man page belongs to a particular * section* :
15+
16+ - 1: User commands (Programs)
17+ - 2: System calls
18+ - 3: Library calls
19+ - 4: Special files (devices)
20+ - 5: File formats and configuration files
21+ - 6: Games
22+ - 7: Overview, conventions, and miscellaneous
23+ - 8: System management commands
24+
25+ Refer to [ man-pages(7)] ( https://man.voidlinux.org/man-pages.7 ) for details.
26+
27+ There are some man pages which have the same name, but are used in different
28+ contexts, and are thus in a different section. You can specify which one to use
29+ by including the section number in the call to ` man ` :
30+
31+ ```
32+ $ man 1 printf
33+ ```
34+
35+ ` man ` can be configured via [ man.conf(5)] ( https://man.voidlinux.org/man.conf.5 ) .
36+
1337The ` mandoc ` toolset contains [ apropos(1)] ( https://man.voidlinux.org/apropos.1 ) ,
1438which can be used to search for manual pages. ` apropos ` uses a database that can
15- be updated and generated with the
16- [ makewhatis(8)] ( https://man.voidlinux.org/makewhatis.8 ) command.
39+ be generated and updated with the
40+ [ makewhatis(8)] ( https://man.voidlinux.org/makewhatis.8 ) command:
1741
1842```
1943# makewhatis -a
@@ -26,5 +50,9 @@ xbps-uunshare(1) - XBPS utility to chroot and bind mount with Linux user namespa
2650chroot(2) - change root directory
2751```
2852
29- ` man-pages-devel ` and ` man-pages-posix ` are extra packages which are not
30- installed by default. They contain development and POSIX manuals, respectively.
53+ The ` mdocml ` package provides a cron job to update the database daily,
54+ ` /etc/cron.daily/makewhatis ` . You will need to install a [ cron
55+ daemon] ( ./cron.md ) for this functionality to be activated.
56+
57+ Development and POSIX manuals are not installed by default, but are available
58+ via the ` man-pages-devel ` and ` man-pages-posix ` packages.
0 commit comments