1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
|
<?xml version='1.0'?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:exsl="http://exslt.org/common"
xmlns:ng="http://docbook.org/docbook-ng"
xmlns:db="http://docbook.org/ns/docbook"
xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0"
exclude-result-prefixes="exsl"
version='1.0'>
<!-- ********************************************************************
This file is part of the XSL DocBook Stylesheet distribution.
See ../README or http://cdn.docbook.org/release/xsl/current/ for
copyright and other information.
******************************************************************** -->
<!-- * This file contains named templates related to things other than -->
<!-- * just assembling the actual text of the main text flow of each man -->
<!-- * page. This "other" stuff currently amounts to these steps: -->
<!-- * -->
<!-- * - get contents of the "map" used to convert special characters -->
<!-- * - output boilerplate messages -->
<!-- * - escape backslash, dot, dash, and apostrophe characters -->
<!-- * - convert non-breaking spaces -->
<!-- * - add a comment to top part of roff source of each page -->
<!-- * - make a .TH title line (for controlling page header/footer) -->
<!-- * - set hyphenation, alignment, indent & line-breaking defaults -->
<!-- * - "prepare" the complete man page contents for final output -->
<!-- * - write the actual man file to the filesystem -->
<!-- * - write any "stub" pages to the filesystem -->
<!-- * -->
<!-- * The templates in this file are actually called only once per -->
<!-- * each Refentry; they are just in a separate file for the purpose -->
<!-- * of keeping things modular. -->
<!-- ==================================================================== -->
<!-- ==================================================================== -->
<!-- * Get character map contents -->
<!-- ==================================================================== -->
<xsl:variable name="man.charmap.contents">
<xsl:if test="$man.charmap.enabled != 0">
<xsl:variable name="lang">
<xsl:call-template name="l10n.language">
<xsl:with-param name="target" select="//refentry[1]"/>
</xsl:call-template>
</xsl:variable>
<xsl:call-template name="read-character-map">
<xsl:with-param name="use.subset" select="$man.charmap.use.subset"/>
<xsl:with-param name="subset.profile">
<xsl:choose>
<xsl:when test="$lang = 'en'">
<xsl:value-of select="$man.charmap.subset.profile.english"/>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="$man.charmap.subset.profile"/>
</xsl:otherwise>
</xsl:choose>
</xsl:with-param>
<xsl:with-param name="uri">
<xsl:choose>
<xsl:when test="$man.charmap.uri != ''">
<xsl:value-of select="$man.charmap.uri"/>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="'../manpages/charmap.groff.xsl'"/>
</xsl:otherwise>
</xsl:choose>
</xsl:with-param>
</xsl:call-template>
</xsl:if>
</xsl:variable>
<!-- ==================================================================== -->
<xsl:template name="root.messages">
<xsl:param name="refname"/>
<!-- redefine this any way you'd like to output messages -->
<!-- DO NOT OUTPUT ANYTHING FROM THIS TEMPLATE -->
<!-- Example:
<xsl:if test="//foo">
<xsl:call-template name="log.message">
<xsl:with-param name="level">Warn</xsl:with-param>
<xsl:with-param name="source" select="$refname"/>
<xsl:with-param name="context-desc">
<xsl:text>limitation</xsl:text>
</xsl:with-param>
<xsl:with-param name="message">
<xsl:text>Output for foo element is not yet supported.</xsl:text>
</xsl:with-param>
</xsl:call-template>
</xsl:if>
-->
</xsl:template>
<!-- ==================================================================== -->
<!-- * Escape roff special chars -->
<!-- ==================================================================== -->
<!-- ******************************************************************** -->
<!-- * -->
<!-- * The backslash, dot, dash, and apostrophe (\, ., -, ') characters -->
<!-- * have special meaning for roff, so before we do any other -->
<!-- * processing, we must escape those characters where they appear in -->
<!-- * the source content. -->
<!-- * -->
<!-- * Here we also deal with replacing U+00a0 (non-breaking space) with -->
<!-- * its roff equivalent -->
<!-- * -->
<!-- ******************************************************************** -->
<xsl:template match="//refentry//text()">
<xsl:call-template name="escape.roff.specials">
<xsl:with-param name="content">
<xsl:value-of select="."/>
</xsl:with-param>
</xsl:call-template>
</xsl:template>
<xsl:template match="//refentry//text()" mode="no.anchor.mode">
<xsl:call-template name="escape.roff.specials">
<xsl:with-param name="content">
<xsl:value-of select="."/>
</xsl:with-param>
</xsl:call-template>
</xsl:template>
<xsl:template name="escape.roff.specials">
<xsl:param name="content"/>
<xsl:call-template name="convert.nobreak-space">
<xsl:with-param name="content">
<xsl:call-template name="escape.apostrophe">
<xsl:with-param name="content">
<xsl:call-template name="escape.dash">
<xsl:with-param name="content">
<xsl:call-template name="escape.dot">
<xsl:with-param name="content">
<xsl:call-template name="escape.backslash">
<xsl:with-param name="content" select="$content"/>
</xsl:call-template>
</xsl:with-param>
</xsl:call-template>
</xsl:with-param>
</xsl:call-template>
</xsl:with-param>
</xsl:call-template>
</xsl:with-param>
</xsl:call-template>
</xsl:template>
<xsl:template name="escape.backslash">
<xsl:param name="content"/>
<xsl:call-template name="string.subst">
<xsl:with-param name="string" select="$content"/>
<xsl:with-param name="target">\</xsl:with-param>
<!-- * we use "\e" instead of "\\" because the groff docs say -->
<!-- * that's the correct thing to do; also because testing -->
<!-- * shows that "\\" doesn't always work as expected; for -->
<!-- * example, "\\" within a table seems to mess things up -->
<xsl:with-param name="replacement">\e</xsl:with-param>
</xsl:call-template>
</xsl:template>
<xsl:template name="escape.dot">
<xsl:param name="content"/>
<xsl:call-template name="string.subst">
<xsl:with-param name="string" select="$content"/>
<xsl:with-param name="target">.</xsl:with-param>
<xsl:with-param name="replacement">\&.</xsl:with-param>
</xsl:call-template>
</xsl:template>
<xsl:template name="escape.dash">
<xsl:param name="content"/>
<xsl:call-template name="string.subst">
<xsl:with-param name="string" select="$content"/>
<xsl:with-param name="target">-</xsl:with-param>
<xsl:with-param name="replacement">\-</xsl:with-param>
</xsl:call-template>
</xsl:template>
<xsl:template name="escape.apostrophe">
<xsl:param name="content"/>
<xsl:call-template name="string.subst">
<xsl:with-param name="string" select="$content"/>
<xsl:with-param name="target">'</xsl:with-param>
<xsl:with-param name="replacement">\*(Aq</xsl:with-param>
</xsl:call-template>
</xsl:template>
<xsl:template name="convert.nobreak-space">
<xsl:param name="content"/>
<xsl:call-template name="string.subst">
<xsl:with-param name="string" select="$content"/>
<xsl:with-param name="target"> </xsl:with-param>
<!-- * A no-break space can be written two ways in roff; the -->
<!-- * difference, according to the "Page Motions" node in the -->
<!-- * groff info page, is: -->
<!-- * -->
<!-- * "\ " = -->
<!-- * An unbreakable and unpaddable (i.e. not expanded -->
<!-- * during filling) space. -->
<!-- * -->
<!-- * "\~" = -->
<!-- * An unbreakable space that stretches like a normal -->
<!-- * inter-word space when a line is adjusted." -->
<!-- * -->
<!-- * Unfortunately, roff seems to do some weird things with -->
<!-- * long lines that only have words separated by "\~" -->
<!-- * spaces, so it's safer just to stick with the "\ " space -->
<!-- * -->
<!-- * We append a "\&" to handle the case of a no-break space that -->
<!-- * appears at the end of a line - because later processing will -->
<!-- * cause that space to get eaten otherwise. -->
<xsl:with-param name="replacement">\ \&</xsl:with-param>
</xsl:call-template>
</xsl:template>
<!-- ==================================================================== -->
<!-- * top.comment generates a comment containing metadata for the man -->
<!-- * page; for example, Author, Generator, and Date information -->
<xsl:template name="top.comment">
<xsl:param name="info"/>
<xsl:param name="date"/>
<xsl:param name="title"/>
<xsl:param name="manual"/>
<xsl:param name="source"/>
<xsl:param name="refname"/>
<xsl:text>.\" Title: </xsl:text>
<xsl:call-template name="replace.dots.and.dashes">
<xsl:with-param name="content" select="$title"/>
</xsl:call-template>
<xsl:text> </xsl:text>
<xsl:text>.\" Author: </xsl:text>
<xsl:call-template name="replace.dots.and.dashes">
<xsl:with-param name="content">
<xsl:call-template name="make.roff.metadata.author">
<xsl:with-param name="info" select="$info"/>
<xsl:with-param name="refname" select="$refname"/>
</xsl:call-template>
</xsl:with-param>
</xsl:call-template>
<xsl:text> </xsl:text>
<xsl:text>.\" Generator: DocBook </xsl:text>
<xsl:value-of select="$DistroTitle"/>
<xsl:text> v</xsl:text>
<xsl:call-template name="replace.dots.and.dashes">
<xsl:with-param name="content" select="$VERSION"/>
</xsl:call-template>
<xsl:text> <http://docbook.sf.net/></xsl:text>
<xsl:text> </xsl:text>
<xsl:text>.\" Date: </xsl:text>
<xsl:call-template name="replace.dots.and.dashes">
<xsl:with-param name="content" select="$date"/>
</xsl:call-template>
<xsl:text> </xsl:text>
<xsl:text>.\" Manual: </xsl:text>
<xsl:call-template name="replace.dots.and.dashes">
<xsl:with-param name="content" select="$manual"/>
</xsl:call-template>
<xsl:text> </xsl:text>
<xsl:text>.\" Source: </xsl:text>
<xsl:call-template name="replace.dots.and.dashes">
<xsl:with-param name="content" select="$source"/>
</xsl:call-template>
<xsl:text> </xsl:text>
<xsl:text>.\" Language: </xsl:text>
<xsl:call-template name="l10n.language.name"/>
<xsl:text> </xsl:text>
<xsl:text>.\"</xsl:text>
<xsl:text> </xsl:text>
</xsl:template>
<!-- ==================================================================== -->
<xsl:template name="TH.title.line">
<!-- * The exact way that .TH contents are displayed is system- -->
<!-- * dependent; it varies somewhat between OSes and roff -->
<!-- * versions. Below is a description of how Linux systems with -->
<!-- * a modern groff seem to render .TH contents. -->
<!-- * -->
<!-- * title(section) extra3 title(section) <- page header -->
<!-- * extra2 extra1 title(section) <- page footer-->
<!-- * -->
<!-- * Or, using the names with which the man(7) man page refers -->
<!-- * to the various fields: -->
<!-- * -->
<!-- * title(section) manual title(section) <- page header -->
<!-- * source date title(section) <- page footer-->
<!-- * -->
<!-- * Note that while extra1, extra2, and extra3 are all (nominally) -->
<!-- * optional, in practice almost all pages include an "extra1" -->
<!-- * field, which is, universally, a date (in some form), and it is -->
<!-- * always rendered in the same place (the middle footer position) -->
<!-- * -->
<!-- * Here are a couple of examples of real-world man pages that -->
<!-- * have somewhat useful page headers/footers: -->
<!-- * -->
<!-- * gtk-options(7) GTK+ User's Manual gtk-options(7) -->
<!-- * GTK+ 1.2 2003-10-20 gtk-options(7) -->
<!-- * -->
<!-- * svgalib(7) Svgalib User Manual svgalib(7) -->
<!-- * Svgalib 1.4.1 16 December 1999 svgalib(7) -->
<!-- * -->
<xsl:param name="title"/>
<xsl:param name="section"/>
<xsl:param name="extra1"/>
<xsl:param name="extra2"/>
<xsl:param name="extra3"/>
<xsl:call-template name="mark.subheading"/>
<!-- * Note that we generate quotes around _every_ field in the -->
<!-- * .TH title line, including the "title" and "section" -->
<!-- * fields. That is because we use the contents of those "as -->
<!-- * is", unchanged from the DocBook source; and DTD-based -->
<!-- * validation does not provide a way to constrain them to be -->
<!-- * "space free" -->
<xsl:text>.TH "</xsl:text>
<xsl:call-template name="string.upper">
<xsl:with-param name="string">
<xsl:choose>
<xsl:when test="$man.th.title.max.length != ''">
<xsl:value-of
select="normalize-space(substring($title, 1, $man.th.title.max.length))"/>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="normalize-space($title)"/>
</xsl:otherwise>
</xsl:choose>
</xsl:with-param>
</xsl:call-template>
<xsl:text>" "</xsl:text>
<xsl:value-of select="normalize-space($section)"/>
<xsl:text>" "</xsl:text>
<xsl:if test="$man.th.extra1.suppress = 0">
<!-- * there is no max.length for the extra1 field; the reason -->
<!-- * is, it is almost always a date, and it is not possible -->
<!-- * to truncate dates without changing their meaning -->
<xsl:value-of select="normalize-space($extra1)"/>
</xsl:if>
<xsl:text>" "</xsl:text>
<xsl:if test="$man.th.extra2.suppress = 0">
<xsl:choose>
<!-- * if max.length is non-empty, use value to truncate field -->
<xsl:when test="$man.th.extra2.max.length != ''">
<xsl:value-of
select="normalize-space(substring($extra2, 1, $man.th.extra2.max.length))"/>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="normalize-space($extra2)"/>
</xsl:otherwise>
</xsl:choose>
</xsl:if>
<xsl:text>" "</xsl:text>
<xsl:if test="$man.th.extra3.suppress = 0">
<xsl:choose>
<!-- * if max.length is non-empty, use value to truncate field -->
<xsl:when test="$man.th.extra3.max.length != ''">
<xsl:value-of
select="normalize-space(substring($extra3, 1, $man.th.extra3.max.length))"/>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="normalize-space($extra3)"/>
</xsl:otherwise>
</xsl:choose>
</xsl:if>
<xsl:text>" </xsl:text>
<xsl:call-template name="mark.subheading"/>
</xsl:template>
<!-- ============================================================== -->
<xsl:template name="set.default.formatting">
<!-- * Set default hyphenation, justification, indentation and -->
<!-- * line-breaking -->
<!-- * -->
<!-- * If the value of man.hypenate is zero (the default), then -->
<!-- * disable hyphenation (".nh" = "no hyphenation") -->
<xsl:text>.\" ----------------------------------------------------------------- </xsl:text>
<xsl:text>.\" * set default formatting </xsl:text>
<xsl:text>.\" ----------------------------------------------------------------- </xsl:text>
<xsl:if test="$man.hyphenate = 0">
<xsl:text>.\" disable hyphenation </xsl:text>
<xsl:text>.nh </xsl:text>
</xsl:if>
<!-- * If the value of man.justify is zero (the default), then -->
<!-- * disable justification (".ad l" means "adjust to left only") -->
<xsl:if test="$man.justify = 0">
<xsl:text>.\" disable justification</xsl:text>
<xsl:text> (adjust text to left margin only) </xsl:text>
<xsl:text>.ad l </xsl:text>
</xsl:if>
<xsl:if test="not($man.indent.refsect = 0)">
<xsl:text>.\" store initial "default indentation value" </xsl:text>
<xsl:text>.nr zq \n(IN </xsl:text>
<xsl:text>.\" adjust default indentation </xsl:text>
<xsl:text>.nr IN </xsl:text>
<xsl:value-of select="$man.indent.width"/>
<xsl:text> </xsl:text>
<xsl:text>.\" adjust indentation of SS headings </xsl:text>
<xsl:text>.nr SN \n(IN </xsl:text>
</xsl:if>
<!-- * Unless the value of man.break.after.slash is zero (the -->
<!-- * default), tell groff that it is OK to break a line -->
<!-- * after a slash when needed. -->
<xsl:if test="$man.break.after.slash != 0">
<xsl:text>.\" enable line breaks after slashes </xsl:text>
<xsl:text>.cflags 4 / </xsl:text>
</xsl:if>
</xsl:template>
<!-- ================================================================== -->
<!-- * The prepare.manpage.contents template is called after all -->
<!-- * other processing has been done, before serializing the -->
<!-- * result of all the other processing. It basically works on -->
<!-- * the result as one big string. -->
<xsl:template name="prepare.manpage.contents">
<xsl:param name="content" select="''"/>
<!-- * If user has provided a "local" string-substitution map to -->
<!-- * be applied /before/ the standard string-substitution map, -->
<!-- * apply it. -->
<xsl:variable name="pre.adjusted.content">
<xsl:choose>
<xsl:when test="$man.string.subst.map.local.pre">
<!-- * normalized value of man.string.subst.map.local.pre -->
<!-- * is non-empty, so get contents of map and apply them -->
<xsl:call-template name="apply-string-subst-map">
<xsl:with-param name="content" select="$content"/>
<xsl:with-param name="map.contents"
select="exsl:node-set($man.string.subst.map.local.pre)/*"/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise>
<!-- * value of man.string.subst.map.local.pre is empty, -->
<!-- * so just copy original contents -->
<xsl:value-of select="$content"/>
</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<!-- * Apply standard string-substitution map. The main purpose -->
<!-- * of this map is to escape certain characters that have -->
<!-- * special meaning in roff, and to replace certain characters -->
<!-- * used within the stylesheet internally to represent roff -->
<!-- * markup characters. -->
<xsl:variable name="adjusted.content">
<xsl:call-template name="apply-string-subst-map">
<xsl:with-param name="content" select="$pre.adjusted.content"/>
<xsl:with-param name="map.contents"
select="exsl:node-set($man.string.subst.map)/*"/>
</xsl:call-template>
</xsl:variable>
<!-- * If user has provided a "local" string-substitution map to -->
<!-- * be applied /after/ the standard string-substitution map, -->
<!-- * apply it. -->
<xsl:variable name="post.adjusted.content">
<xsl:choose>
<xsl:when test="$man.string.subst.map.local.post">
<!-- * normalized value of man.string.subst.map.local.post -->
<!-- * is non-empty, so get contents of map and apply them -->
<xsl:call-template name="apply-string-subst-map">
<xsl:with-param name="content" select="$adjusted.content"/>
<xsl:with-param name="map.contents"
select="exsl:node-set($man.string.subst.map.local.post)/*"/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise>
<!-- * value of man.string.subst.map.local.post is empty, -->
<!-- * so just copy original contents -->
<xsl:value-of select="$adjusted.content"/>
</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<!-- * Optionally, apply a character map to replace Unicode -->
<!-- * symbols and special characters. -->
<xsl:choose>
<xsl:when test="$man.charmap.enabled != 0">
<xsl:call-template name="apply-character-map">
<xsl:with-param name="content" select="$post.adjusted.content"/>
<xsl:with-param name="map.contents"
select="exsl:node-set($man.charmap.contents)/*"/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise>
<!-- * if we reach here, value of $man.charmap.enabled is zero, -->
<!-- * so we just pass the adjusted contents through "as is" -->
<xsl:value-of select="$adjusted.content"/>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<!-- ================================================================== -->
<xsl:template name="write.man.file">
<xsl:param name="name"/>
<xsl:param name="section"/>
<xsl:param name="lang"/>
<xsl:param name="content"/>
<xsl:param name="filename">
<xsl:call-template name="make.adjusted.man.filename">
<xsl:with-param name="name" select="$name"/>
<xsl:with-param name="section" select="$section"/>
<xsl:with-param name="lang" select="$lang"/>
</xsl:call-template>
</xsl:param>
<xsl:call-template name="write.text.chunk">
<xsl:with-param name="filename" select="$filename"/>
<xsl:with-param name="suppress-context-node-name" select="1"/>
<xsl:with-param name="quiet" select="$man.output.quietly"/>
<xsl:with-param
name="message-prolog"
>Note: </xsl:with-param>
<xsl:with-param name="encoding" select="$man.output.encoding"/>
<xsl:with-param name="content" select="$content"/>
</xsl:call-template>
</xsl:template>
<!-- ============================================================== -->
<!-- * A "stub" is sort of alias for another file, intended to be read -->
<!-- * and expanded by soelim(1); it's simply a file whose complete -->
<!-- * contents are just a single line of the following form: -->
<!-- * -->
<!-- * .so manX/realname.X -->
<!-- * -->
<!-- * "realname" is a name of another man-page file. That .so line is -->
<!-- * basically a roff "include" statement. When the man command finds -->
<!-- * it, it calls soelim(1) and includes and displays the contents of -->
<!-- * the manX/realqname.X file. -->
<!-- * -->
<!-- * If a refentry has multiple refnames, we generate a "stub" page for -->
<!-- * each refname found, except for the first one. -->
<xsl:template name="write.stubs">
<xsl:param name="first.refname"/>
<xsl:param name="section"/>
<xsl:param name="lang"/>
<xsl:for-each select="refnamediv/refname">
<xsl:if test=". != $first.refname">
<xsl:call-template name="write.text.chunk">
<xsl:with-param name="filename">
<xsl:call-template name="make.adjusted.man.filename">
<xsl:with-param name="name" select="."/>
<xsl:with-param name="section" select="$section"/>
<xsl:with-param name="lang" select="$lang"/>
</xsl:call-template>
</xsl:with-param>
<xsl:with-param name="quiet" select="$man.output.quietly"/>
<xsl:with-param name="suppress-context-node-name" select="1"/>
<xsl:with-param name="message-prolog">Note: </xsl:with-param>
<xsl:with-param name="message-epilog"> (soelim stub)</xsl:with-param>
<xsl:with-param name="content">
<xsl:choose>
<xsl:when test="$man.output.in.separate.dir = 0">
<xsl:value-of select="concat('.so man', $section, '/')"/>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="'.so '"/> <!-- added case -->
</xsl:otherwise>
</xsl:choose>
<xsl:variable name="full.filename">
<xsl:call-template name="make.adjusted.man.filename">
<xsl:with-param name="name" select="$first.refname"/>
<xsl:with-param name="section" select="$section"/>
<xsl:with-param name="lang" select="$lang"/>
</xsl:call-template>
</xsl:variable>
<xsl:choose>
<xsl:when test="starts-with($full.filename, $man.output.base.dir)">
<xsl:value-of
select="substring-after($full.filename,$man.output.base.dir)"/>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="$full.filename"/>
</xsl:otherwise>
</xsl:choose>
<xsl:text> </xsl:text>
</xsl:with-param>
</xsl:call-template>
</xsl:if>
</xsl:for-each>
</xsl:template>
<!-- ============================================================== -->
<!-- * A manifest file is useful for doing "make clean" during -->
<!-- * builds and for other purposes. When we make the manifest -->
<!-- * file, we need to include in it a filename for each man-page -->
<!-- * generated, including any "stub" pages. -->
<xsl:template name="generate.manifest">
<xsl:variable name="filelist">
<xsl:for-each select="//refentry">
<!-- * all refname instances in a Refentry inherit their section -->
<!-- * numbers from the parent Refentry; so we only need to get -->
<!-- * the section once per Refentry, not once per Refname -->
<xsl:variable name="section">
<xsl:call-template name="get.refentry.section">
<xsl:with-param name="quiet" select="1"/>
</xsl:call-template>
</xsl:variable>
<xsl:variable name="lang">
<xsl:call-template name="l10n.language"/>
</xsl:variable>
<xsl:for-each select="refnamediv/refname">
<xsl:call-template name="make.adjusted.man.filename">
<xsl:with-param name="name" select="."/>
<xsl:with-param name="section" select="$section"/>
<xsl:with-param name="lang" select="$lang"/>
</xsl:call-template>
<xsl:text> </xsl:text>
</xsl:for-each>
</xsl:for-each>
</xsl:variable>
<!-- * we write the manifest file once per document, not once per -->
<!-- * Refentry -->
<xsl:call-template name="write.text.chunk">
<xsl:with-param name="filename">
<xsl:value-of select="$man.output.manifest.filename"/>
</xsl:with-param>
<xsl:with-param name="quiet" select="1"/>
<xsl:with-param name="message-prolog">Note: </xsl:with-param>
<xsl:with-param name="message-epilog"> (manifest file)</xsl:with-param>
<xsl:with-param name="content">
<xsl:value-of select="$filelist"/>
</xsl:with-param>
</xsl:call-template>
<xsl:if test="$man.output.quietly = 0">
<xsl:message><xsl:text> </xsl:text></xsl:message>
</xsl:if>
</xsl:template>
<!-- ============================================================== -->
<!-- There is some stuff, that is not portable between groff/troff. -->
<xsl:template name="define.portability.macros">
<xsl:text>.\" ----------------------------------------------------------------- </xsl:text>
<xsl:text>.\" * Define some portability stuff </xsl:text>
<xsl:text>.\" ----------------------------------------------------------------- </xsl:text>
<xsl:text>.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ </xsl:text>
<xsl:text>.\" http://bugs.debian.org/507673 </xsl:text>
<xsl:text>.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html </xsl:text>
<xsl:text>.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ </xsl:text>
<xsl:text> </xsl:text>
<xsl:text>.ie \n(.g .ds Aq \(aq</xsl:text>
<xsl:text> </xsl:text>
<xsl:text>.el .ds Aq '</xsl:text>
<xsl:text> </xsl:text>
</xsl:template>
<!-- ============================================================== -->
<xsl:template name="define.macros">
<xsl:text>.\" ----------------------------------------------------------------- </xsl:text>
<xsl:text>.\" * (re)Define some macros </xsl:text>
<xsl:text>.\" ----------------------------------------------------------------- </xsl:text>
<xsl:text>.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ </xsl:text>
<xsl:text>.\" toupper - uppercase a string (locale-aware) </xsl:text>
<xsl:text>.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ </xsl:text>
<xsl:text>.de toupper </xsl:text>
<xsl:text>.tr</xsl:text>
<xsl:text> </xsl:text>
<xsl:call-template name="make.tr.uppercase.arg"/>
<xsl:text>\\$* </xsl:text>
<xsl:text>.tr</xsl:text>
<xsl:text> </xsl:text>
<xsl:call-template name="make.tr.normalcase.arg"/>
<xsl:text>.. </xsl:text>
<xsl:text>.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ </xsl:text>
<xsl:text>.\" SH-xref - format a cross-reference to an SH section </xsl:text>
<xsl:text>.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ </xsl:text>
<xsl:text>.de SH-xref
.ie n \{\
.\}
.toupper \\$*
.el \{\
\\$*
.\}
.. </xsl:text>
<xsl:text>.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ </xsl:text>
<xsl:text>.\" SH - level-one heading that works better for non-TTY output </xsl:text>
<xsl:text>.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ </xsl:text>
<xsl:text>.de1 SH </xsl:text>
<xsl:text>.\" put an extra blank line of space above the head in non-TTY output </xsl:text>
<xsl:call-template name="roff-if-start">
<xsl:with-param name="condition">t</xsl:with-param>
</xsl:call-template>
<xsl:text>.sp 1 </xsl:text>
<xsl:call-template name="roff-if-end"/>
<xsl:text>.sp \\n[PD]u
.nr an-level 1
.set-an-margin
.nr an-prevailing-indent \\n[IN]
.fi
.in \\n[an-margin]u
.ti 0
.HTML-TAG ".NH \\n[an-level]"
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
\." make the size of the head bigger
.ps +3
.ft B
.ne (2v + 1u)
.ie n \{\
.\" if n (TTY output), use uppercase
.toupper \\$*
.\}
.el \{\
.nr an-break-flag 0
.\" if not n (not TTY), use normal case (not uppercase)
\\$1
.in \\n[an-margin]u
.ti 0
.\" if not n (not TTY), put a border/line under subheading
.sp -.6
\l'\n(.lu'
.\}
.. </xsl:text>
<xsl:text>.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ </xsl:text>
<xsl:text>.\" SS - level-two heading that works better for non-TTY output </xsl:text>
<xsl:text>.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ </xsl:text>
<xsl:text>.de1 SS
.sp \\n[PD]u
.nr an-level 1
.set-an-margin
.nr an-prevailing-indent \\n[IN]
.fi
.in \\n[IN]u
.ti \\n[SN]u
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.ps \\n[PS-SS]u
\." make the size of the head bigger
.ps +2
.ft B
.ne (2v + 1u)
.if \\n[.$] \&\\$*
.. </xsl:text>
<xsl:text>.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ </xsl:text>
<xsl:text>.\" BB/EB - put background/screen (filled box) around block of text </xsl:text>
<xsl:text>.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ </xsl:text>
<xsl:text>.de BB
.if t \{\
.sp -.5
.br
.in +2n
.ll -2n
.gcolor red
.di BX
.\}
..
.de EB
.if t \{\
.if "\\$2"adjust-for-leading-newline" \{\
.sp -1
.\}
.br
.di
.in
.ll
.gcolor
.nr BW \\n(.lu-\\n(.i
.nr BH \\n(dn+.5v
.ne \\n(BHu+.5v
.ie "\\$2"adjust-for-leading-newline" \{\
\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
.\}
.el \{\
\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
.\}
.in 0
.sp -.5v
.nf
.BX
.in
.sp .5v
.fi
.\}
.. </xsl:text>
<xsl:text>.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ </xsl:text>
<xsl:text>.\" BM/EM - put colored marker in margin next to block of text </xsl:text>
<xsl:text>.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ </xsl:text>
<xsl:text>.de BM
.if t \{\
.br
.ll -2n
.gcolor red
.di BX
.\}
..
.de EM
.if t \{\
.br
.di
.ll
.gcolor
.nr BH \\n(dn
.ne \\n(BHu
\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
.in 0
.nf
.BX
.in
.fi
.\}
.. </xsl:text>
</xsl:template>
<xsl:template name="make.tr.uppercase.arg">
<xsl:call-template name="string.shuffle">
<xsl:with-param name="string1">
<xsl:call-template name="gentext">
<xsl:with-param name="key" select="'lowercase.alpha'"/>
</xsl:call-template>
</xsl:with-param>
<xsl:with-param name="string2">
<xsl:call-template name="gentext">
<xsl:with-param name="key" select="'uppercase.alpha'"/>
</xsl:call-template>
</xsl:with-param>
</xsl:call-template>
<xsl:text> </xsl:text>
</xsl:template>
<xsl:template name="make.tr.normalcase.arg">
<xsl:call-template name="string.shuffle">
<xsl:with-param name="string1">
<xsl:call-template name="gentext">
<xsl:with-param name="key" select="'lowercase.alpha'"/>
</xsl:call-template>
</xsl:with-param>
<xsl:with-param name="string2">
<xsl:call-template name="gentext">
<xsl:with-param name="key" select="'lowercase.alpha'"/>
</xsl:call-template>
</xsl:with-param>
</xsl:call-template>
<xsl:text> </xsl:text>
</xsl:template>
<xsl:template name="string.shuffle">
<!-- * given two strings, "shuffle" them together into one -->
<xsl:param name="string1"/>
<xsl:param name="string2"/>
<xsl:value-of select="substring($string1, 1, 1)"/>
<xsl:value-of select="substring($string2, 1, 1)"/>
<xsl:if test="string-length($string1) > 1">
<xsl:call-template name="string.shuffle">
<xsl:with-param name="string1">
<xsl:value-of select="substring($string1, 2)"/>
</xsl:with-param>
<xsl:with-param name="string2">
<xsl:value-of select="substring($string2, 2)"/>
</xsl:with-param>
</xsl:call-template>
</xsl:if>
</xsl:template>
</xsl:stylesheet>
|