Commit Graph

9 Commits

Author SHA1 Message Date
Karel Zak 6a23bf93fd docs: update Documentation/howto-man-page.txt
Signed-off-by: Karel Zak <kzak@redhat.com>
2021-03-29 15:10:53 +02:00
Bjarni Ingi Gislason 37f26093c9 doc: howto-man-page.txt: Use font macros instead of font escapes
Use font macros instead of font escapes (\f[BIPR]).

  The escape '\c' ("connect to next input text")
is used to join the output of two macros without a space character.
This is similar to the '\' escape at the end of a line.

  Font escapes make the text more difficult to read.

###
  Changes based on:

  Use a macro to change to the italic font,
instead of \fI [1], if possible.
  The macros have the italic corrections,
but "\c" removes the "\/" part.

  Or

add the italic corrections.
[1] man-pages(7) [Debian package "manpages"]

###

Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a

1) name for an option

2) negative number to be printed.

###

Wrong distance between sentences or protect the indicator.

a) Separate the sentences and subordinate clauses;
each begins on a new line.
See man-pages(7) [package "manpages"] and "info groff".

Or

b) Adjust space between sentences (two spaces),

c) or protect the indicator by adding "\&" after it.

The "indicator" is an "end-of-sentence character" (.!?).

  The amount of space between sentences in the output can then be
controlled with the ".ss" request.

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
2019-12-17 12:32:43 +01:00
Sébastien Helleu d673b74e9d docs: replace FTP by HTTPS in kernel.org URLs
The links to ftp://ftp.kernel.org/ are replaced by
https://www.kernel.org/.

Signed-off-by: Karel Zak <kzak@redhat.com>
2016-12-19 11:22:26 +01:00
Sami Kerola 326c5c93b9
docs: optinal option arguments should be long-only
Deprecate adding new short optional option arguments.  They are problematic.

Proposed-by: Ruediger Meier <sweet_f_a@gmx.de>
Acked-by: Karel Zak <kzak@redhat.com>
Reviewed-by: Benno Schulenberg <bensberg@justemail.net>
Reference: https://lists.gnu.org/archive/html/coreutils/2012-11/msg00004.html
Reference: http://marc.info/?l=util-linux-ng&m=146062997618853&w=2
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2016-04-16 23:08:18 +01:00
Benno Schulenberg cfbebb2905 docs: improve the wording and conventions in the man-page howto
Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2014-07-17 14:00:52 +02:00
Karel Zak 505dedfec4 docs: fix minor things in man-page howto
Signed-off-by: Karel Zak <kzak@redhat.com>
2014-06-25 13:21:15 +02:00
Sami Kerola 8a69abf0de docs: fix email macro in manual example
URL macro is not email address macro.

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2012-05-31 20:12:06 +02:00
Petr Uzel 89c6bb4dad docs: trivial documentation fixes and improvements
Signed-off-by: Petr Uzel <petr.uzel@suse.cz>
2012-02-22 11:52:07 +01:00
Sami Kerola 05620dd47e docs: new file Documentation/howto-man-page.txt
The howto-man-page.txt is an example of good groff syntax and
document about man page at the same time.

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-08-23 21:34:21 +02:00