docs/master

annotate style @ 167:4b6518242c73

find changesets by author, revision, files, or words in the commit message
style: Improved typography of .Ci macro.
author markus schnalke <meillo@marmaro.de>
date Tue, 10 Jul 2012 10:26:04 +0200
parents 1b9bdc178610
children 97461b0b34d2
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@0 39 .nr PI 3n
meillo@41 40 .nr PD .3v
meillo@91 41 .nr QI 6n
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 . LP
meillo@0 91 . de FP
meillo@0 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@81 135 . \" H- - Chapter unnumbered and not in TOC ($2=="no" -> no page hdrs)
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@40 154 .if !,\\$2,no, \{
meillo@40 155 . EH "\\\\*(_E
meillo@40 156 . ie \\n(H1 .OH "\\\\*(_O
meillo@40 157 . el .OH "\\\\*(_o
meillo@40 158 . ds CF \\n(PN
meillo@40 159 .\}
meillo@81 160 .RT
meillo@29 161 .sp 4
meillo@29 162 .nr PP 0
meillo@29 163 ..
meillo@29 164
meillo@81 165 . \" H0 - Chapter ($2=="no" -> not numbered)
meillo@0 166 .de H0
meillo@0 167 .EH "
meillo@0 168 .OH "
meillo@0 169 .bp
meillo@81 170 .if e .rs \" begin chapter on an odd page
meillo@0 171 .if e .bp
meillo@81 172 .lg 0
meillo@81 173 .nr PS +6
meillo@81 174 .nr VS +6
meillo@81 175 .ie ,\\$2,no, .SH
meillo@81 176 .el \{\
meillo@0 177 . NH 1
meillo@0 178 . ce 1
meillo@0 179 Chapter \\*(SN
meillo@0 180 . sp .5
meillo@0 181 .\}
meillo@81 182 .ce 1
meillo@81 183 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
meillo@0 184 \&\\$1
meillo@81 185 .br
meillo@81 186 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
meillo@81 187 .nr PS -6
meillo@81 188 .nr VS -6
meillo@81 189 .lg
meillo@81 190 .\" add to TOC
meillo@79 191 .rm t_
meillo@79 192 .if !,\\$2,no, .ds t_ \\*(SN\0\0
meillo@79 193 .T_ .5v 0 "\fB\\*(t_\\$1
meillo@81 194 .\" set page headers and footers
meillo@29 195 .EH "\\\\*(_E
meillo@81 196 .ds _C "\\$1
meillo@29 197 .ie \\n(H1 .OH "\\\\*(_O
meillo@29 198 .el .OH "\\\\*(_o
meillo@29 199 .ds CF \\n(PN
meillo@81 200 .RT
meillo@0 201 .sp 4
meillo@0 202 .nr PP 0
meillo@0 203 ..
meillo@0 204
meillo@39 205
meillo@81 206 . \" H1 - Section ($2=="no" -> not numbered)
meillo@0 207 .de H1
meillo@0 208 .br
meillo@0 209 .ne 7
meillo@1 210 .sp
meillo@81 211 .lg 0
meillo@81 212 .nr PS +2
meillo@81 213 .nr VS +2
meillo@81 214 .ie '\\$2'no' .SH
meillo@81 215 .el .NH 2
meillo@6 216 .if !'\\$2'no' \&\\*(SN
meillo@81 217 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
meillo@81 218 \&\\$1
meillo@81 219 .br
meillo@81 220 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
meillo@81 221 .nr PS -2
meillo@81 222 .nr VS -2
meillo@81 223 .lg
meillo@81 224 .if !'\\$2'no' .T_ .3v 1 "\\*(SN\0\0\\$1 \" add to TOC
meillo@81 225 .RT
meillo@6 226 .nr PP 0
meillo@6 227 ..
meillo@6 228
meillo@81 229 . \" H2 - Subsection
meillo@6 230 .de H2
meillo@6 231 .br
meillo@7 232 .ne 4
meillo@59 233 .NH 3
meillo@81 234 \&\\*(SN \\$1
meillo@81 235 .T_ 0 2 "\\*(SN\0\0\\$1 \" add to TOC
meillo@11 236 .RT
meillo@11 237 .nr PP 0
meillo@11 238 ..
meillo@11 239
meillo@81 240 . \" U2 - Subsection unnumbered
meillo@11 241 .de U2
meillo@11 242 .br
meillo@11 243 .ne 4
meillo@11 244 .SH
meillo@81 245 \&\\$1
meillo@11 246 .RT
meillo@0 247 .nr PP 0
meillo@0 248 ..
meillo@0 249
meillo@81 250 . \" U3 - Subsubsection unnumbered
meillo@73 251 .de U3
meillo@73 252 .br
meillo@73 253 .ne 4
meillo@73 254 .RT
meillo@73 255 .sp
meillo@73 256 .I "\\$1
meillo@73 257 .RT
meillo@73 258 .nr PP 0
meillo@73 259 ..
meillo@73 260
meillo@81 261 . \" P - Paragraph (indented unless following a heading)
meillo@0 262 .de P
meillo@0 263 .ie \\n(PP .PP
meillo@0 264 .el .LP
meillo@0 265 .nr PP 1
meillo@0 266 ..
meillo@0 267
meillo@81 268 . \" IP - Paragraph with hanging label
meillo@0 269 .am IP
meillo@0 270 .nr PP 0
meillo@0 271 ..
meillo@0 272
meillo@81 273 . \" BU - Bulleted paragraph
meillo@6 274 .de BU
meillo@6 275 .IP \(bu
meillo@6 276 ..
meillo@6 277
meillo@98 278 . \" QS - Block quote start
meillo@98 279 .de QS
meillo@91 280 .ti \\n(.iu
meillo@137 281 .\"RT
meillo@98 282 .sp 2u*\\n(PDu
meillo@91 283 .ne 1.1
meillo@0 284 .ps -1
meillo@103 285 .vs -1
meillo@91 286 .in +\\n(QIu
meillo@91 287 .ll -\\n(QIu
meillo@91 288 .ti \\n(.iu
meillo@98 289 .\"if \\n(Qp .ti +\\n(PIu
meillo@98 290 .\"nr QP 1
meillo@98 291 .\"rr Qp
meillo@98 292 ..
meillo@98 293
meillo@98 294 . \" QP - Block quote paragraph
meillo@98 295 .de QP
meillo@98 296 .sp \n(PDu
meillo@98 297 .ne 1.1
meillo@98 298 .ti +\\n(PIu
meillo@98 299 ..
meillo@98 300
meillo@98 301 . \" QP - Block quote end
meillo@98 302 .de QE
meillo@98 303 .sp \\n(PDu
meillo@98 304 .in -\\n(QIu
meillo@98 305 .ll +\\n(QIu
meillo@98 306 .ti \\n(.iu
meillo@103 307 .ps +1
meillo@103 308 .vs +1
meillo@0 309 ..
meillo@0 310
meillo@81 311 . \" DS - Code display
meillo@0 312 .am DS
meillo@0 313 .ft CW
meillo@0 314 .ps -1
meillo@0 315 .ta T 8n
meillo@0 316 ..
meillo@0 317
meillo@82 318 . \" VS - verbatim text start (\\ -> ^G; ' -> disabled; . -> ^B)
meillo@82 319 .de VS
meillo@82 320 .br
meillo@119 321 .ne 3
meillo@82 322 .sp \n(DDu
meillo@119 323 .di _V
meillo@82 324 .nf
meillo@82 325 .ft CW
meillo@119 326 .ps -.5
meillo@82 327 .\" set up verbatim environment
meillo@82 328 \.blm
meillo@82 329 \.ec 
meillo@82 330 \.c2 ""
meillo@82 331 \.cc 
meillo@82 332 ..
meillo@82 333
meillo@82 334 . \" VE - verbatim text end (NOTE: Needs to be called as ^BVE !)
meillo@82 335 .de VE
meillo@82 336 \" restore the special characters
meillo@82 337 cc
meillo@82 338 .c2
meillo@82 339 .ec
meillo@119 340 .br
meillo@119 341 .di
meillo@119 342 .ne \\n(dnu+1v \" ensure enough space on the page
meillo@119 343 .if t .in +.5i
meillo@119 344 .if n .in +8n
meillo@119 345 .ta T 8n
meillo@119 346 \.ec  \" set up verbatim environment, once again
meillo@119 347 \.c2 ""
meillo@119 348 \.cc 
meillo@119 349 _V \" output the verbatim content
meillo@119 350 \" restore the special characters
meillo@119 351 cc
meillo@119 352 .c2
meillo@119 353 .ec
meillo@82 354 .blm __
meillo@82 355 .if t .in -.5i
meillo@82 356 .if n .in -8n
meillo@82 357 .sp \n(DDu
meillo@82 358 .ft P
meillo@82 359 .fi
meillo@82 360 .TA
meillo@82 361 ..
meillo@82 362
meillo@83 363 . \" VF - verbatim text from file ($1=filename)
meillo@83 364 .de VF
meillo@83 365 .VS
meillo@83 366 so $1
meillo@83 367 VE
meillo@83 368 ..
meillo@83 369
meillo@81 370 . \" FA - XXX somehow related to footnotes?
meillo@0 371 .am FA
meillo@0 372 .ps 8
meillo@0 373 .vs 9
meillo@0 374 ..
meillo@18 375
meillo@18 376 .de Fn \" file name
meillo@18 377 .CW "\\$1" "\\$2
meillo@18 378 ..
meillo@18 379 .de Pn \" program name
meillo@18 380 .CW "\\$1" "\\$2
meillo@18 381 ..
meillo@18 382 .de Fu \" function
meillo@18 383 .CW "\\$1" "\\$2
meillo@18 384 ..
meillo@19 385 .de Ev \" env variable
meillo@19 386 .CW "\\$1" "\\$2
meillo@19 387 ..
meillo@18 388 .de Cl \" command line
meillo@18 389 `\c
meillo@18 390 .CW "\\$1" "'\\$2
meillo@18 391 ..
meillo@18 392 .de Sw \" switch
meillo@18 393 .CW "\\$1" "\\$2
meillo@18 394 ..
meillo@84 395 .de Ar \" argument
meillo@84 396 .CW "\f(CI\\$1" "\\$2
meillo@84 397 ..
meillo@18 398 .de Mp \" man page
meillo@18 399 .I "\\$1" "\\$2
meillo@18 400 ..
meillo@18 401 .de Pe \" profile entry
meillo@18 402 .CW "\\$1" "\\$2
meillo@18 403 ..
meillo@84 404 .de Hd \" mail header field
meillo@84 405 .CW "\\$1:\&" "\\$2
meillo@84 406 ..
meillo@67 407
meillo@81 408 .de Ci \" commit hash ref
meillo@70 409 .ds _t \\$1
meillo@70 410 .substring _t 0 6
meillo@167 411 [\(rh\|\fL\\*(_t\fP]\\$2
meillo@67 412 ..
meillo@77 413
meillo@151 414 . \" Cf - reference within the document ($1=name of ref file)
meillo@151 415 .de Cf
meillo@151 416 \.if !\\nZ .so refs/\\$1 \c
meillo@151 417 \\$2
meillo@77 418 ..
meillo@151 419
meillo@151 420 . \" Id - put a referenceable marker here ($1=identifier)
meillo@151 421 .de Id
meillo@151 422 .tm REF____\\$1\t\\*(SN\t\\n(PN
meillo@151 423 ..