: 2001-10-19 Ruslan Ermilov <ru@FreeBSD.org>
:
: * tmac/doc.tmac (doc-flag-recursion): Protect arguments against
: being handled as end-of-sentence characters,
This fixes ".Fl \&?". Previously, it produced an additional whitespace.
There were no precedents in FreeBSD manpages. That's why it was
Noticed by: Thomas Klausner <wiz@netbsd.org>
: 2001-08-14 Ruslan Ermilov <ru@FreeBSD.org>
:
: * tmac/doc.tmac (Ex): New implementation.
: * tmac/doc-common, tmac/groff_tmac.man: Updated.
This adds a new macro, .Ex (Exit Status), for use in the
DIAGNOSTICS section of section 1, 6 and 8 manpages.
Prodded by: dd
: 2001-08-13 Ruslan Ermilov <ru@FreeBSD.org>
:
: * tmac/doc.tmac (Rv): Implement support for 0 or more than 1
: argument.
: * tmac/groff_tmac.man: Updated.
All of the following are now valid:
.Rv -std f1
.Rv -std f1 f2
.Rv -std f1 f2 f3
.Rv -std
The last form is useful where the standard return behavior is applicable
to all of the functions described in this particular manpage. Look, for
example, at the stat(2), setresuid(2), and utimes(2) manpages.
The form with >1 functions is useful in a mixed environment. See the
fhopen(2) manpage for an example.
Prodded by: yar
: 2001-07-18 Ruslan Ermilov <ru@FreeBSD.org>
:
: * tmac/groff_mdoc.man: Document new -width and -column syntax.
: Some other minor fixes.
: * tmac/an-old.tmac: Add `AT' and `UC' macros.
Fold -xwidth functionality into -width. .Bl now tests whether
string immediately following a leading dot starts with a valid
macro name.
Added similar functionality to the -column list's column width
specifiers. For example, the following now works as expected:
.Bl -column ".Va hw.crusoe.percentage" ".Vt integer" "Changeable"
.It Sy "Name\tType\tChangeable\tDescription"
.It Va hw.crusoe.longrun Ta Vt integer Ta yes Ta "LongRun mode:"
.It Ta Ta Ta "0: minimum frequency mode"
.It Ta Ta Ta "1: power-saving mode"
.It Ta Ta Ta "2: performance mode"
.It Ta Ta Ta "3: maximum frequency mode"
.It Va hw.crusoe.frequency Ta Vt integer Ta no Ta "Current frequency (MHz)."
.It Va hw.crusoe.voltage Ta Vt integer Ta no Ta "Current voltage (mV)."
.It Va hw.crusoe.percentage Ta Vt integer Ta no Ta "Processing performance (%)."
.El
This is especially useful for groff devices with variable width
fonts, like -Tps or -TX100.
- .Fn and .Fc now print a final semicolon (`;') after a
function declaration in the SYNOPSIS
- .%I implemented
- .At outputs ``AT&T UNIX'' if called without arguments
- minor cleanup
Obtained from: CSRG archives
- spell the abbreviation of 1003.1 as ``POSIX.1''
- fixed the description of -p1003.1-90; it was sold as ISO/IEC 9945-1:1990
- removed -p1003.1b; it only existed as 1003.1b-1993 (-p1003.1b-93), and
is part of 1003.1 since 1003.1-1996.
- replaced -p1003.1g (project) with -p1003.1g-2000 (approved draft)
- changed abbreviation of -isoC from ``ISO C'' to ``ISO C89''
- removed -iso9899 alias for -isoC
- IEC was missing from some names
- added abbreviation for -susv2 (``SUSv2'')
If the -tag list definition didn't have a -width modifier,
the first .It call was supposed to set the width depending
on the first argument type; if it is a macro name, use the
macro's width value; otherwise, use width value of `No'.
The following two lists should produce identical output:
.Bl -tag -width Er -compact
.It Er EINVAL
invalid argument
.El
.Bl -tag -compact
.It Er EINVAL
invalid argument
.El
If the outermost -tag list definition did't have a -width
modifier, the .It elements of inner lists might not work
(producing a list where each successive element `walks' to
the right).
Example:
.Bl -tag -compact
.It outer
.It outer
.Bl -tag -compact
.It inner
.It inner
.El
.It outer
.It outer
.El
Ported from: mdocNG
default .Ar argument as an end-of-sentence character.
Example:
.Ar
foo
Produced:
file ... foo
Now produces:
file ... foo
2. Fixed an off-by-one bug in the .It macro for the -hang lists.
Example:
.Bl -hang -width 8n -compact
.It 1234
OK
.It 1234567
OK
.It 12345678
BUG
.El
Produced:
1234 OK
1234567 OK
12345678 BUG
Now produces:
1234 OK
1234567 OK
12345678 BUG
Ported from: mdocNG
2. Disable recognition of end-of-sentence characters in text-type
macro arguments.
3. Fix the missing space bug when an end-of-sentence character was
followed by another punctuation character.
4. Fix the bug where hyphenation was left disabled after .Re.
Obtained from: mdocNG
argument to setup indentation for the rest of the synopsis
line and to automatically emit a line break for a non-first
synopsis line. It does not require it anymore.
The following now works as expected:
.Sh NAME
.Nm utility
.Sh SYNOPSIS
.Nm
.Cm start
.Nm
.Cm stop
One can now, for example, write:
.Sh EXAMPLES
Have you read the
.Xr mdoc 7 ?
.Pp
Do you like
.Fx ?
The mdoc.samples(7) page has been automatically updated to
record this change.
use of the .ne requests. groff(1) apparently inserts some virtual trap at
the end of each page, and this was causing the .ne request to output extra
lines. Solution is to only use them in troff mode.
Also fixed a related bug in .It macros, where it would insert a page break
in the middle of a sentence.
Removed the end of page trap in nroff mode, as this causes .sp requests to
sometimes eat the space due to the nearby trap.
Removed blank line that appeared as the first line on each nroff-formatted
manual page.
Obtained from: NetBSD
for function. For example: for stat(2) syscall (owned by libc) we will add
following code:
.Sh LIBRARY
.Lb libc
and it will be rendered to:
LIBRARY
Standard C Library (libc, -lc)
Suggested by: mpp
Idea obtained from: NetBSD
page of -mdoc manual pages in troff mode. The problem has been
introduced in rev 1.12; apparently ending a line inside a macro
definition with \c doesn't behave as Bill expected, and troff was
fooled to believe previous output was already pending thus a new page
needed to be emitted. Using a troff comment .\" instead of \c seems
to solve this, alas the brain^Wnice sed(1) magic needs to be taught to
_not_ strip those comments now.
I think -stable is not affected by this.
the argument is a known FreeBSD version or not.
Output an nroff error if .Fx is used with an unknown FreeBSD version.
Change .Nx and .Ox macros to always display the argument, whether
the argument is a known version or not. This eliminates much of the
need to syncrhonize .Nx and .Ox with their source OS's -- only the
exceptions (like ".Nx 1.2a" -> "NetBSD 1.2A") where the argument is
not directly copied to the output need to be added.
"October 14, 1998". A Y2k fix makes it now display "October 14, 98+1900".
Appears you can perform arithmetic in a string definition.
PR: gnu/8321
Reviewed by: Andrew J. Korty <ajk@purdue.edu>
The .Fx macro was missing 2.1.7.
Add 2.2.5 to both .Os and .Fx. If I'm wrong about the version
number, no big deal - it can be removed later, but I wanted
to be able to get this into 2.2 so that when I'm using a
2.2 system ome months down the line, man pages intended for (what I
think will be the next 2.2 release) will be formatted properly.
Also fix a typo in a comment.
This will make a number of things easier in the future, as well as (finally!)
avoiding the Id-smashing problem which has plagued developers for so long.
Boy, I'm glad we're not using sup anymore. This update would have been
insane otherwise.
Kernel Interfaces Manual
This was needed because of a few man pages like keyboard(4)
which caused the header to become unreadable with the longer
description.
Add the .Fx macro for specifying FreeBSD releases.
Add a bunch of missing standards to the .St macro.
Add Version 1 AT&T UNIX to .At macro
Updated the ".St -ansiC" macro to report "ISO 9899: 1990 (``ISO C'')"
You can also specify -iso9899, or -isoC. Use -ansiC-89 if you still need
the X3.159-1989 string reported.
Original author: mpp
