docs/master

annotate style @ 208:fead1fc981f0

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