Menu

#107 use .MR for references to man-pages

Default
open
1
2024-05-12
2024-05-12
No

the manpage of groff_man_style

See also
tbl(1), eqn(1), and refer(1) are preprocessors used with man pages. man(1) de‐
scribes the man page librarian on your system.

is written using the .MR macro

  .SH "See also"
  .
  .MR \%tbl 1 ,
  .MR \%eqn 1 ,
  and
  .MR \%refer 1
  are preprocessors used with man pages.
  .
  .MR man 1
  describes the man page librarian on your system.

But then the rST input would loo like

See also
--------

tbl(1), eqn(1), and refer(1) are preprocessors used with man pages.  
man(1)  describes  the man page librarian on your system.

meaning we need to find the already formatted manpage references , which could be anywhere
in the text (except code . in code man(1) would be calling function man)

Discussion

  • engelbert gruber

    • Description has changed:

    Diff:

    --- old
    +++ new
    @@ -21,7 +21,7 @@
    
     But then the rST input would loo like
    
    - ~~~
    +~~~
     See also
     --------
    
     
  • G. Branden Robinson

    Just a quick note. You will not need to generate the arguments to the MR macro with a leading \% escape sequence. The groff_man_style man page has them here for complicated reasons; the short version is that the tbl, eqn, and refer programs can be installed with a prefix ("g" is a popular choice) determined by the builder of groff at compilation time, because groff supports being installed simultaneously with another (usually AT&T or AT&T-descended) troff. The prefix can be expanded in contexts where hyphenation is not disabled (MR always shuts it off while formatting its arguments), so a hyphenation control escape sequence is always prepended, even if the prefix is empty. This is harmless. I just wanted to point it out so that you don't think you have to generate these escape sequences in the output you produce.

     

    Last edit: G. Branden Robinson 2024-05-12

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.