NetBSD/distrib/notes/common/macros

.\" $NetBSD: macros,v 1.5 2000/10/05 08:54:04 lukem Exp $
.\"
.\" Copyright (c) 1999, 2000 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Ross Harvey.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"        This product includes software developed by the NetBSD
.\"        Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\"    contributors may be used to endorse or promote products derived
.\"    from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.\"	--------------------  MACROS  --------------------
.
.
.\" Define a .CURDIR-relative include, with entertainment
.
.rn so so-real
.de so
.	tm ...reading \\$1
.	Pp
.	so-real \*[.CURDIR]/\\$1
.\"	tm ...back to INSTALL
..
.als source so
.
.\" -mdoc only has only two section levels (Sh & Ss)
.
.\" second-level subsection macro (third-level section)
.
.de Ss2
.	ie rHTML <h5><a name="\\$*">\\$*</a></h5>
.	el \{\
.		br
.		if t .ne 7P
.		Pp
.		Em "\\$*"
.		Pp
.	\}
..
.
.
.\" standard display, with nice showmatch parens in the name
.
.
.de (disp
.	Bd -literal -offset indent
..
.
.de disp)
.	Ed
..
.
.
.de br_ne
.	br
.	if t .ne \\$1
..
.
.
.
.\" Degenerate case of tagged list: a single tagged paragraph, possibly
.\" followed by more (.Pp) paragraphs at the same indent level. Uses the
.\" last parameter specified for the width, so things like .(tag Em tagfun
.\" will DTRT. End the sequence with ``.tag)''.
.\"
.
.
.de (tag
.	Bl -tag -width x\\$\\n[.$]
.	It \\$@
.
..
.de tag)
.	El
..
.
.de (Note
.	(tag Em Note
..
.
.de Note)
.	tag)
..
.
.de D2
.	Pp
.	Dl Ic $@
..
.
.\"	--------------------  MISC  --------------------
.
.\" set the unused target number registers to 0, so that we can turn on all
.\" the warnings but still do things like .if \n[amiga]:\n[alpha] \&stuff
.\" (The Makefile defines the target as 1, leaving the others undefined.)
.
.de define_all
.	while \\n[.$] \{\
.		if !r\\$1 .nr \\$1 0
.		shift
.	\}
..
.
.define_all \*[MACHINE_LIST]
.
.\" Define _ versions, sometimes these look better as with .if r_xxx
.
.nr _FOR_RELEASE \n[FOR_RELEASE]
.nr _\*[MACHINE] 1
.
.de (note
.	(Note
..
.de note)
.	Note)
..