X-Git-Url: https://git.distorted.org.uk/~mdw/sod/blobdiff_plain/8698accbb89627bf7358f6614de713be11bde3b8..6bed6ea3e51d812189d2ef2d5f9418632079db71:/common/defs.man diff --git a/common/defs.man b/common/defs.man new file mode 100644 index 0000000..8b14ee3 --- /dev/null +++ b/common/defs.man @@ -0,0 +1,111 @@ +.\" -*-nroff-*- +.\" +.\" Common definitions for Sod manpages +.\" +.\" (c) 2008 Straylight/Edgeware +.\" +. +.\"----- Licensing notice --------------------------------------------------- +.\" +.\" This file is part of the Sensible Object Design, an object system for C. +.\" +.\" SOD is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU Library General Public License as +.\" published by the Free Software Foundation; either version 2 of the +.\" License, or (at your option) any later version. +.\" +.\" SOD is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU Library General Public License for more details. +.\" +.\" You should have received a copy of the GNU Library General Public +.\" License along with SOD; if not, write to the Free +.\" Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, +.\" MA 02111-1307, USA. +. +.\"-------------------------------------------------------------------------- +.\" Preliminary definitions. +. +.\" Font selection. +.ie t \{\ +. if \n(.g \{\ +. fam P +. ev an-1 +. fam P +. ev +. \} +.\} +. +.\" Character definitions. +.ie t \{\ +. ds o \(bu \" bullet for lists +. ds e \(*e \" empty nonterminal +. ds ^ \v'-.3m'\s'\\n(.s*7/10' \" begin superscript +. ds ^e \s0\v'.3m' \" end superscript +. ds _ \v'.3m'\s'\\n(.s*7/10' \" begin subscript +. ds _e \s0\v'-.3m' \" end subscript +.\} +.el \{\ +. ds o o \" bullet for lists +. ds e \fIe\fR \" empty nonterminal +. ds ^ ^ \" begin superscript +. ds ^e \" end superscript +. ds _ _ \" begin subscript +. ds _e \" end subscript +.\} +.ds * \*^\(**\*(^e \" superscript `*' (zero or more) +.ds + \*^+\*(^e \" superscript `+' (one or more) +. +.\" .hP TEXT -- start an indented paragraph with TEXT hanging off to the left +.de hP +.IP +\h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c +.. +. +.\" .SP -- equivalent to .TP, but indicates item should be summarized +.de SP +.TP +.. +. +.\" .VS ... .VE -- present a code example +.de VS +.sp 1 +.RS +.nf +.ft B +.. +.de VE +.ft R +.fi +.RE +.sp 1 +.. +. +.\" .t( ... .t) -- tabbing: align contents at current horizontal position +.de t( +'in +\\n(.ku +.. +.de t) +.in +.. +. +.\" .| -- syntax alternative on a new line +.de | +.br +\h'4n'| +.. +. +.\" .< -- newline and indent only in nroff mode (for shorter lines) +.ie t \{\ +. de < +.. +.\} +.el \{ +. de < +. br +\h'4n' +.. +.\} +. +.\"----- That's all, folks --------------------------------------------------