docs/master

annotate style @ 170:97461b0b34d2

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