docs/master

annotate style @ 189:22feb390ccc4

find changesets by author, revision, files, or words in the commit message
Applied suggestions by Lydi.
author markus schnalke <meillo@marmaro.de>
date Wed, 11 Jul 2012 15:53:53 +0200
parents 846f6a67f44e
children 5060e8cd7e59
rev   line source
meillo@0 1 .do xflag 3
meillo@0 2 .de __
meillo@0 3 ..
meillo@0 4 .blm __ \" ignore empty lines in input
meillo@0 5 .lc_ctype en_US.utf8
meillo@0 6 .mediasize a4
meillo@0 7
meillo@0 8 .fp 1 R LinLibertine_R otf
meillo@0 9 .feature R +onum
meillo@0 10 .fp 2 I LinLibertine_RI otf
meillo@0 11 .feature I +onum
meillo@0 12 .fp 3 B LinLibertine_RB otf
meillo@0 13 .feature B +onum
meillo@0 14 .fp 4 BI LinLibertine_RBI otf
meillo@0 15 .feature BI +onum
meillo@0 16 .fp 5 CW TerminusMedium-4.36 ttf
meillo@0 17 .fp 0 CI TerminusMediumItalic-4.36 ttf
meillo@0 18 .fp 0 CB TerminusBold-4.36 ttf
meillo@0 19 .fp 0 L TerminusMedium-4.36 ttf
meillo@82 20 .ftr CW -\-`\`'\'
meillo@82 21 .ftr CI -\-`\`'\'
meillo@82 22 .ftr CB -\-`\`'\'
meillo@82 23 .ftr L -\-`\`'\'
meillo@15 24 .fp 0 SC LinLibertine_R otf
meillo@15 25 .feature SC +onum +smcp
meillo@15 26 .fp 0 IC LinLibertine_RI otf
meillo@15 27 .feature IC +onum +smcp
meillo@0 28 .fp 0 BC LinLibertine_RB otf
meillo@0 29 .feature BC +onum +smcp
meillo@0 30
meillo@0 31 .ig
meillo@75 32 . nr PS 11
meillo@75 33 . nr VS 13
meillo@75 34 . padj
meillo@0 35 ..
meillo@0 36
meillo@152 37 .ss 12 0 \" the second (non-portable) argument requests french spacing
meillo@152 38
meillo@170 39 .nr PI 4n
meillo@41 40 .nr PD .3v
meillo@170 41 .nr QI 2u*\n(PIu
meillo@0 42 .nr lu 0
meillo@0 43 .af PN i
meillo@0 44
meillo@15 45 .ds _E '\\\\n(PN''\f(SCMarkus Schnalke: The Modern Mail Handler\fP' \" left
meillo@185 46 .ds _a '\f(SCAppendix \\\\n(H1\ \ \\\\*(_C\fP''\\\\n(PN' \" right
meillo@15 47 .ds _O '\f(SCChapter \\\\n(H1\ \ \\\\*(_C\fP''\\\\n(PN' \" right
meillo@29 48 .ds _o '\f(SC\\\\*(_C\fP''\\\\n(PN' \" right
meillo@0 49 .ds CH "
meillo@0 50
meillo@0 51 .nr HM 3.3c
meillo@0 52 .nr FM 6.6c
meillo@75 53 .nr LL 13c
meillo@75 54 .ll 13c
meillo@0 55 .nr LT \n(LL
meillo@0 56
meillo@81 57 . \" _M - change margins for text block on next page
meillo@81 58 .de _M
meillo@99 59 .if t .if o .nr PO 5c
meillo@99 60 .if t .if e .nr PO 3c
meillo@0 61 .ds CF "
meillo@0 62 ..
meillo@0 63 .wh -1u _M
meillo@0 64
meillo@90 65 . \" Lp - enlarge the current page by one line to avoid widows
meillo@90 66 .de Lp
meillo@90 67 .ch FO -\n(FMu+1v
meillo@90 68 ..
meillo@90 69
meillo@81 70 . \" CW - Set text in CW font (similar to .B and .I)
meillo@0 71 .de CW
meillo@0 72 .nr PQ \\n(.f
meillo@0 73 .if t \{\
meillo@0 74 . ft CW
meillo@0 75 . if !^\\$1^^ \&\\$1\f\\n(PQ\\$2
meillo@0 76 .\}
meillo@0 77 .if n \{\
meillo@0 78 . ie ^\\$1^^ .ul 999
meillo@0 79 . el .ul 1
meillo@0 80 . if \\n(.$=1 \&\\$1
meillo@0 81 . if \\n(.$>1 \&\\$1\c
meillo@0 82 . if \\n(.$>1 \&\\$2
meillo@0 83 .\}
meillo@0 84 ..
meillo@0 85
meillo@81 86 . \" refer(1) stuff
meillo@35 87 .ds [. " [
meillo@0 88 .ds .] ]
meillo@0 89 .rm ]<
meillo@0 90 .de ]<
meillo@0 91 . de FP
meillo@170 92 . IP \\\\$1
meillo@0 93 \\..
meillo@0 94 . rm FS FE
meillo@0 95 ..
meillo@0 96
meillo@81 97 . \" PT - page top macro of ms
meillo@0 98 .am PT
meillo@0 99 . rs
meillo@0 100 ..
meillo@0 101
meillo@81 102
meillo@81 103 . \" RN - Reset PN and continue on an odd page ($1=number-format)
meillo@81 104 .de RN
meillo@81 105 .ie e .pn 1
meillo@81 106 .el \{
meillo@81 107 . pn 0
meillo@81 108 . bp
meillo@81 109 .\}
meillo@81 110 .ie \\n(.$=1 .af PN \\$1
meillo@81 111 .el .af PN 1
meillo@81 112 ..
meillo@81 113
meillo@81 114
meillo@81 115 . \" T_ - Add TOC entry ($1=pre-space $2=indent-level $3=text)
meillo@81 116 .de T_
meillo@79 117 .tm TOC____.sp \\$1
meillo@79 118 .tm TOC____\&\\h'\\$2u*2u*\\n(PIu'\\$3\0\0\a\t\\n(PN\fR
meillo@79 119 ..
meillo@79 120
meillo@81 121 . \" NH - redefine numbered heading
meillo@0 122 .de NH
meillo@0 123 .SH
meillo@0 124 .nr NS \\$1
meillo@0 125 .if !\\n(.$ .nr NS 1
meillo@0 126 .if !\\n(NS .nr NS 1
meillo@0 127 .nr H\\n(NS +1
meillo@6 128 .if \\n(NS<2 .nr H2 0
meillo@6 129 .if \\n(NS<3 .nr H3 0
meillo@0 130 .ds SN \\n(H1
meillo@6 131 .if \\n(NS>1 .as SN \&.\\n(H2
meillo@6 132 .if \\n(NS>2 .as SN \&.\\n(H3
meillo@0 133 ..
meillo@0 134
meillo@185 135 . \" H- - Chapter not numbered and not in TOC
meillo@40 136 .de H-
meillo@29 137 .EH "
meillo@29 138 .OH "
meillo@29 139 .bp
meillo@81 140 .if e .rs \" move to an odd page
meillo@29 141 .if e .bp
meillo@29 142 .lg 0
meillo@29 143 .nr PS +6
meillo@29 144 .nr VS +6
meillo@29 145 .SH
meillo@29 146 .ce 1
meillo@29 147 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
meillo@29 148 \&\\$1
meillo@29 149 .br
meillo@29 150 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
meillo@29 151 .nr PS -6
meillo@29 152 .nr VS -6
meillo@29 153 .lg
meillo@185 154 .EH "\\\\*(_E
meillo@185 155 .OH "\\\\*(_o
meillo@185 156 .ds CF \\n(PN
meillo@81 157 .RT
meillo@29 158 .sp 4
meillo@29 159 .nr PP 0
meillo@29 160 ..
meillo@29 161
meillo@185 162 . \" AP - Start the Appendix
meillo@185 163 .de AP
meillo@185 164 .nr _A 1
meillo@185 165 .nr H1 0
meillo@185 166 .af H1 A
meillo@185 167 ..
meillo@185 168
meillo@81 169 . \" H0 - Chapter ($2=="no" -> not numbered)
meillo@0 170 .de H0
meillo@0 171 .EH "
meillo@0 172 .OH "
meillo@0 173 .bp
meillo@81 174 .if e .rs \" begin chapter on an odd page
meillo@0 175 .if e .bp
meillo@81 176 .lg 0
meillo@81 177 .nr PS +6
meillo@81 178 .nr VS +6
meillo@81 179 .ie ,\\$2,no, .SH
meillo@81 180 .el \{\
meillo@0 181 . NH 1
meillo@0 182 . ce 1
meillo@185 183 .ie \\n(_A Appendix \\*(SN
meillo@185 184 .el Chapter \\*(SN
meillo@0 185 . sp .5
meillo@0 186 .\}
meillo@81 187 .ce 1
meillo@81 188 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
meillo@0 189 \&\\$1
meillo@81 190 .br
meillo@81 191 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
meillo@81 192 .nr PS -6
meillo@81 193 .nr VS -6
meillo@81 194 .lg
meillo@81 195 .\" add to TOC
meillo@79 196 .rm t_
meillo@79 197 .if !,\\$2,no, .ds t_ \\*(SN\0\0
meillo@79 198 .T_ .5v 0 "\fB\\*(t_\\$1
meillo@81 199 .\" set page headers and footers
meillo@29 200 .EH "\\\\*(_E
meillo@81 201 .ds _C "\\$1
meillo@185 202 .ie ,\\$2,no, .OH "\\\\*(_o
meillo@185 203 .el .ie \\n(_A .OH "\\\\*(_a
meillo@185 204 .el .OH "\\\\*(_O
meillo@29 205 .ds CF \\n(PN
meillo@81 206 .RT
meillo@0 207 .sp 4
meillo@0 208 .nr PP 0
meillo@0 209 ..
meillo@0 210
meillo@39 211
meillo@81 212 . \" H1 - Section ($2=="no" -> not numbered)
meillo@0 213 .de H1
meillo@0 214 .br
meillo@0 215 .ne 7
meillo@1 216 .sp
meillo@81 217 .lg 0
meillo@81 218 .nr PS +2
meillo@81 219 .nr VS +2
meillo@81 220 .ie '\\$2'no' .SH
meillo@81 221 .el .NH 2
meillo@6 222 .if !'\\$2'no' \&\\*(SN
meillo@81 223 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
meillo@81 224 \&\\$1
meillo@81 225 .br
meillo@81 226 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
meillo@81 227 .nr PS -2
meillo@81 228 .nr VS -2
meillo@81 229 .lg
meillo@81 230 .if !'\\$2'no' .T_ .3v 1 "\\*(SN\0\0\\$1 \" add to TOC
meillo@81 231 .RT
meillo@6 232 .nr PP 0
meillo@6 233 ..
meillo@6 234
meillo@81 235 . \" H2 - Subsection
meillo@6 236 .de H2
meillo@6 237 .br
meillo@7 238 .ne 4
meillo@59 239 .NH 3
meillo@81 240 \&\\*(SN \\$1
meillo@81 241 .T_ 0 2 "\\*(SN\0\0\\$1 \" add to TOC
meillo@11 242 .RT
meillo@11 243 .nr PP 0
meillo@11 244 ..
meillo@11 245
meillo@81 246 . \" U2 - Subsection unnumbered
meillo@11 247 .de U2
meillo@11 248 .br
meillo@11 249 .ne 4
meillo@11 250 .SH
meillo@81 251 \&\\$1
meillo@11 252 .RT
meillo@0 253 .nr PP 0
meillo@0 254 ..
meillo@0 255
meillo@81 256 . \" U3 - Subsubsection unnumbered
meillo@73 257 .de U3
meillo@73 258 .br
meillo@73 259 .ne 4
meillo@73 260 .RT
meillo@73 261 .sp
meillo@73 262 .I "\\$1
meillo@73 263 .RT
meillo@73 264 .nr PP 0
meillo@73 265 ..
meillo@73 266
meillo@81 267 . \" P - Paragraph (indented unless following a heading)
meillo@0 268 .de P
meillo@0 269 .ie \\n(PP .PP
meillo@0 270 .el .LP
meillo@0 271 .nr PP 1
meillo@0 272 ..
meillo@0 273
meillo@170 274 .am LP
meillo@170 275 .nr PP 1
meillo@170 276 ..
meillo@170 277
meillo@170 278
meillo@170 279 . \" LI - Numbered paragraph ``list item'' ($1=label)
meillo@170 280 .de LI
meillo@170 281 .ie \\n(.$ .IP "\\h'\\n(PIu'\\$1." 2u*\\n(PIu
meillo@170 282 .el .IP "\\h'\\n(PIu'\\(bu" 2u*\\n(PIu
meillo@170 283 .nr PP 1
meillo@170 284 ..
meillo@170 285 .ig \" backup
meillo@170 286 .ie \\n(.$ .IP "\h'1n'\\$1"
meillo@170 287 .el .IP "\h'1.5n'\\(bu"
meillo@0 288 ..
meillo@0 289
meillo@81 290 . \" BU - Bulleted paragraph
meillo@6 291 .de BU
meillo@170 292 .LI
meillo@6 293 ..
meillo@6 294
meillo@98 295 . \" QS - Block quote start
meillo@98 296 .de QS
meillo@91 297 .ti \\n(.iu
meillo@137 298 .\"RT
meillo@98 299 .sp 2u*\\n(PDu
meillo@91 300 .ne 1.1
meillo@0 301 .ps -1
meillo@103 302 .vs -1
meillo@91 303 .in +\\n(QIu
meillo@91 304 .ll -\\n(QIu
meillo@91 305 .ti \\n(.iu
meillo@98 306 .\"if \\n(Qp .ti +\\n(PIu
meillo@98 307 .\"nr QP 1
meillo@98 308 .\"rr Qp
meillo@98 309 ..
meillo@98 310
meillo@98 311 . \" QP - Block quote paragraph
meillo@98 312 .de QP
meillo@98 313 .sp \n(PDu
meillo@98 314 .ne 1.1
meillo@98 315 .ti +\\n(PIu
meillo@98 316 ..
meillo@98 317
meillo@98 318 . \" QP - Block quote end
meillo@98 319 .de QE
meillo@98 320 .sp \\n(PDu
meillo@98 321 .in -\\n(QIu
meillo@98 322 .ll +\\n(QIu
meillo@98 323 .ti \\n(.iu
meillo@103 324 .ps +1
meillo@103 325 .vs +1
meillo@0 326 ..
meillo@0 327
meillo@81 328 . \" DS - Code display
meillo@0 329 .am DS
meillo@0 330 .ft CW
meillo@0 331 .ps -1
meillo@0 332 .ta T 8n
meillo@0 333 ..
meillo@0 334
meillo@82 335 . \" VS - verbatim text start (\\ -> ^G; ' -> disabled; . -> ^B)
meillo@82 336 .de VS
meillo@82 337 .br
meillo@119 338 .ne 3
meillo@82 339 .sp \n(DDu
meillo@119 340 .di _V
meillo@82 341 .nf
meillo@82 342 .ft CW
meillo@119 343 .ps -.5
meillo@82 344 .\" set up verbatim environment
meillo@82 345 \.blm
meillo@82 346 \.ec 
meillo@82 347 \.c2 ""
meillo@82 348 \.cc 
meillo@82 349 ..
meillo@82 350
meillo@82 351 . \" VE - verbatim text end (NOTE: Needs to be called as ^BVE !)
meillo@82 352 .de VE
meillo@82 353 \" restore the special characters
meillo@82 354 cc
meillo@82 355 .c2
meillo@82 356 .ec
meillo@119 357 .br
meillo@119 358 .di
meillo@119 359 .ne \\n(dnu+1v \" ensure enough space on the page
meillo@175 360 .in +2u*\\n(PIu
meillo@119 361 .ta T 8n
meillo@119 362 \.ec  \" set up verbatim environment, once again
meillo@119 363 \.c2 ""
meillo@119 364 \.cc 
meillo@119 365 _V \" output the verbatim content
meillo@119 366 \" restore the special characters
meillo@119 367 cc
meillo@119 368 .c2
meillo@119 369 .ec
meillo@82 370 .blm __
meillo@175 371 .in -2u*\\n(PIu
meillo@82 372 .sp \n(DDu
meillo@82 373 .ft P
meillo@82 374 .fi
meillo@82 375 .TA
meillo@82 376 ..
meillo@82 377
meillo@83 378 . \" VF - verbatim text from file ($1=filename)
meillo@83 379 .de VF
meillo@83 380 .VS
meillo@83 381 so $1
meillo@83 382 VE
meillo@83 383 ..
meillo@83 384
meillo@81 385 . \" FA - XXX somehow related to footnotes?
meillo@0 386 .am FA
meillo@0 387 .ps 8
meillo@0 388 .vs 9
meillo@0 389 ..
meillo@18 390
meillo@18 391 .de Fn \" file name
meillo@18 392 .CW "\\$1" "\\$2
meillo@18 393 ..
meillo@18 394 .de Pn \" program name
meillo@18 395 .CW "\\$1" "\\$2
meillo@18 396 ..
meillo@18 397 .de Fu \" function
meillo@18 398 .CW "\\$1" "\\$2
meillo@18 399 ..
meillo@19 400 .de Ev \" env variable
meillo@19 401 .CW "\\$1" "\\$2
meillo@19 402 ..
meillo@18 403 .de Cl \" command line
meillo@18 404 `\c
meillo@18 405 .CW "\\$1" "'\\$2
meillo@18 406 ..
meillo@18 407 .de Sw \" switch
meillo@18 408 .CW "\\$1" "\\$2
meillo@18 409 ..
meillo@84 410 .de Ar \" argument
meillo@84 411 .CW "\f(CI\\$1" "\\$2
meillo@84 412 ..
meillo@18 413 .de Mp \" man page
meillo@18 414 .I "\\$1" "\\$2
meillo@18 415 ..
meillo@18 416 .de Pe \" profile entry
meillo@18 417 .CW "\\$1" "\\$2
meillo@18 418 ..
meillo@84 419 .de Hd \" mail header field
meillo@84 420 .CW "\\$1:\&" "\\$2
meillo@84 421 ..
meillo@67 422
meillo@81 423 .de Ci \" commit hash ref
meillo@70 424 .ds _t \\$1
meillo@70 425 .substring _t 0 6
meillo@167 426 [\(rh\|\fL\\*(_t\fP]\\$2
meillo@67 427 ..
meillo@77 428
meillo@151 429 . \" Cf - reference within the document ($1=name of ref file)
meillo@151 430 .de Cf
meillo@151 431 \.if !\\nZ .so refs/\\$1 \c
meillo@151 432 \\$2
meillo@77 433 ..
meillo@151 434
meillo@151 435 . \" Id - put a referenceable marker here ($1=identifier)
meillo@151 436 .de Id
meillo@151 437 .tm REF____\\$1\t\\*(SN\t\\n(PN
meillo@151 438 ..