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
8b3dfd7ea9
asciidoctor-foodogsquared-e.../lib/asciidoctor/man-inline-macro
History
Gabriel Arazas 8b3dfd7ea9 Fix man inline macro 
This should fix the double slash in the link.
2023-03-12 10:25:13 +08:00
..
extension.rb Fix man inline macro 2023-03-12 10:25:13 +08:00
README.adoc Update man inline macro with fixed service types instead of domain 2023-03-11 16:34:48 +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.

  • service is the domain of the online manpage service. Take note this attribute is only used in html backend.

    This is an attribute that expects certain values:

    Any invalid value raises an error.

Example usage

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

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