docs/master

annotate style @ 225:d83ab437e3a6

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