Re: [PATCH 3/3] Use subsections instead of sections

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Alejandro:

I have applied all your patches but have one question.  Consider the
following sample manual page, which uses the .TP subsubsectioning technique
you have recommended.  In the sample, observe the difference between
subsubsections 1a and 1b.

    FOO(7)                 Linux Programmer's Manual                 FOO(7)

    NAME
           foo - sample to illustrate manual-page markup

    DESCRIPTION
           Lorem ipsum dolor sit amet, consectetur adipiscing elit.

       Subsection 1
           Sed at ante.

           Subsubsection 1a
                  Mauris  eleifend,  quam  a  vulputate  dictum, massa quam
                  dapibus leo, eget vulputate  orci  purus  ut  lorem.   In
                  fringilla mi in ligula.

           Sss 1b Pellentesque  aliquam  quam  vel dolor.  Nunc adipiscing.
                  Sed quam odio, tempus ac, aliquam  molestie,  varius  ac,
                  tellus.

           Subsubsection 1c
                  Vestibulum  ut nulla aliquam risus rutrum interdum.  Pel‐
                  lentesque lorem.  Curabitur sit amet erat quis risus feu‐
                  giat viverra.

       Subsection 2
           Pellentesque augue justo, sagittis et, lacinia at.

    CONFORMING TO
           Example.

    Linux                          1970-01-01                        FOO(7)

Groff has typeset subsubsection 1a as you like it, but has typeset
subsubsection 1b, which has a shorter title, differently.  This is okay
with me, but is it okay with you?

[No such short title occurs in filename(7), but such a short title might
occur in another, future manual page that emulated the technique.  This
is why I ask.]

Sample source follows.

---------------------------------------------------------------------------
.TH FOO 7 1970-01-01 "Linux" "Linux Programmer's Manual"
.SH NAME
foo \- sample to illustrate manual-page markup
.SH DESCRIPTION
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
.SS Subsection 1
Sed at ante.
.TP
.B Subsubsection 1a
Mauris eleifend, quam a vulputate dictum,
massa quam dapibus leo,
eget vulputate orci purus ut lorem.
In fringilla mi in ligula.
.TP
.B Sss 1b
Pellentesque aliquam quam vel dolor.
Nunc adipiscing.
Sed quam odio, tempus ac, aliquam molestie, varius ac, tellus.
.TP
.B Subsubsection 1c
Vestibulum ut nulla aliquam risus rutrum interdum.
Pellentesque lorem.
Curabitur sit amet erat quis risus feugiat viverra.
.SS Subsection 2
Pellentesque augue justo, sagittis et, lacinia at.
.SH CONFORMING TO
Example.

Attachment: signature.asc
Description: PGP signature


[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux