1. Forum
  2. Usenet
  3. COMP.UNIX.BSD.FREEBSD.MIS

  • man page command or convention for subheaders?

    From Winston@21:1/5 to All on Thu Mar 7 02:19:46 2024
    A FreeBSD man page I'm trying to edit uses ".Sh" for the
    main headers. Is there a macro or formatting convention
    for subheaders kind of like HTML's <h1> <h2> <h3>, or
    like text documents have Chapter 1, 1.1, 1.2, 2, ...?
    TIA,
    -WBE

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)
  • From Christian Weisgerber@21:1/5 to Winston on Thu Mar 7 11:07:53 2024
    On 2024-03-07, Winston <[email protected]d> wrote:

    A FreeBSD man page I'm trying to edit uses ".Sh" for the
    main headers. Is there a macro or formatting convention
    for subheaders kind of like HTML's <h1> <h2> <h3>, or
    like text documents have Chapter 1, 1.1, 1.2, 2, ...?

    Check what's documented in mdoc(7).

    --
    Christian "naddy" Weisgerber [email protected]

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)
  • From Winston@21:1/5 to I originally on Thu Mar 7 10:46:11 2024
    I originally asked:
    A FreeBSD man page I'm trying to edit uses ".Sh" for the
    main headers. Is there a macro or formatting convention
    for subheaders kind of like HTML's <h1> <h2> <h3>, or
    like text documents have Chapter 1, 1.1, 1.2, 2, ...?

    Christian Weisgerber <[email protected]> kindly replied:
    Check what's documented in mdoc(7).

    Got it. Thanks!

    Under "Physical enclosures" are macros for surrounding text in
    double quotes, single quotes, parentheses, etc.
    I can understand using .Dq to get typographical quotes, but is
    there an advantage to doing, say, .Qq foo rather than just
    having "foo" outright as text, or using .Aq text rather than
    just writing <text>?
    -WBE

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)
  • From Felix Palmen@21:1/5 to All on Thu Mar 14 11:42:08 2024
    * Winston <[email protected]d>:
    I can understand using .Dq to get typographical quotes, but is
    there an advantage to doing, say, .Qq foo rather than just
    having "foo" outright as text, or using .Aq text rather than
    just writing <text>?

    Semantics. In these specific cases, the renderer can e.g. use
    typographic quotes and brackets, even depending on current locale.

    --
    Dipl.-Inform. Felix Palmen <[email protected]> ,.//..........
    {web} http://palmen-it.de {jabber} [see email] ,//palmen-it.de
    {pgp public key} http://palmen-it.de/pub.txt // """""""""""
    {pgp fingerprint} 6936 13D5 5BBF 4837 B212 3ACC 54AD E006 9879 F231

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)