foodogsquared/asciidoctor-foodogsquared-extensions
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/asciidoctor-foodogsquared-extensions.git synced 2025-01-31 10:58:11 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
567c52d80a
asciidoctor-foodogsquared-e.../lib/asciidoctor/man-inline-macro
History
Gabriel Arazas dca17c64e7 Update according to Rubocop linter
2023-03-07 01:04:21 +08:00
..
extension.rb Update according to Rubocop linter 2023-03-07 01:04:21 +08:00
README.adoc Add README to man inline macro 2023-03-05 14:20:41 +08:00

README.adoc

Table of Contents

It’s a inline macro that easily links manual pages from an online manpage service like Debian Manpages.

Synopsis

man:$MANPAGE[$VOLNUM]

Attributes

There are optional attributes that can be passed.

  • volnum expects the section number where the manual page belongs to. This attribute is another way to indicate the section in case you start to use more attributes. The value from volnum attribute has higher precedence. When both the positional argument and volnum attribute is passed, the volnum attribute will be used.

  • domain is the domain of the online manpage service. By default, it uses manpages.debian.org.

Example usage

  • man:crontab[5] will link to the default manpage service with crontab(5) manual page.

  • man:man[volnum=1, domain=man.archlinux.org/man] will link to the man manpage from man.archlinux.org.