olink.docbook-xsl.params.man.th.extra3.max.length.xml Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of olink-maven-plugin Show documentation

There is a newer version: 1.2.6



man.th.extra3.max.length
integer


man.th.extra3.max.length
Maximum length of extra3 in header/footer




30



Description

Specifies the maximum permitted length of the
extra3 part of the man-page .TH
title line header/footer. If the extra3 content
exceeds the maxiumum specified, it is truncated down to the maximum
permitted length.

The content of the extra3 field is usually
displayed in the middle header of the page and is typically a "manual
name"; for example, "GTK+ User's Manual" (from the
gtk-options(7) man page).

The default value for this parameter is reasonable but somewhat
arbitrary. If you are processing pages with long "manual names" -- or
especially if you are processing pages that have both long "title"
parts (command/function, etc. names) and long
manual names -- you may want to experiment with changing the value in
order to achieve the correct aesthetic results.