diff options
Diffstat (limited to '')
| -rw-r--r-- | DEPENDENCIES | 5 | ||||
| -rw-r--r-- | doc/info/appx/fdl.texinfo | 505 | ||||
| -rw-r--r-- | doc/info/appx/free-software-needs-free-documentation.texinfo | 31 | ||||
| -rw-r--r-- | doc/info/chap/invoking.texinfo | 31 | ||||
| -rw-r--r-- | doc/info/chap/overview.texinfo | 9 | ||||
| -rw-r--r-- | doc/info/content.texinfo | 28 | ||||
| -rw-r--r-- | doc/info/hardcopy-copying.texinfo | 70 | ||||
| -rw-r--r-- | doc/info/reusable/macros.texinfo | 48 | ||||
| -rw-r--r-- | doc/info/reusable/paper.texinfo | 109 | ||||
| -rw-r--r-- | doc/info/reusable/titlepage.texinfo | 79 | ||||
| -rw-r--r-- | doc/info/titlepage-data.texinfo | 23 | ||||
| -rw-r--r-- | doc/info/vtchs.texinfo | 104 |
12 files changed, 1042 insertions, 0 deletions
diff --git a/DEPENDENCIES b/DEPENDENCIES index f111215..34266f3 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -11,10 +11,15 @@ BUILD DEPENDENCIES cc make coreutils + texinfo>=4.11 (opt-out, for info, pdf, dvi, ps, and html manuals) + texlive-plainextra (opt-in, for pdf, dvi, and ps manuals) + + texinfo<4.11 can be used if '@frenchspacing on' is removed. INSTALL DEPENDENCIES make coreutils + texinfo (opt-out, for dir-entry of info manual) diff --git a/doc/info/appx/fdl.texinfo b/doc/info/appx/fdl.texinfo new file mode 100644 index 0000000..cb71f05 --- /dev/null +++ b/doc/info/appx/fdl.texinfo @@ -0,0 +1,505 @@ +@c The GNU Free Documentation License. +@center Version 1.3, 3 November 2008 + +@c This file is intended to be included within another document, +@c hence no sectioning command or @node. + +@display +Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. +@uref{http://fsf.org/} + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. +@end display + +@enumerate 0 +@item +PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +functional and useful document @dfn{free} in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. + +This License is a kind of ``copyleft'', which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. + +We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. + +@item +APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The ``Document'', below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as ``you''. You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. + +A ``Modified Version'' of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. + +A ``Secondary Section'' is a named appendix or a front-matter section +of the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. + +The ``Invariant Sections'' are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. + +The ``Cover Texts'' are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. + +A ``Transparent'' copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not ``Transparent'' is called ``Opaque''. + +Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, La@TeX{} input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, SGML or +XML for which the DTD and/or processing tools are +not generally available, and the machine-generated HTML, +PostScript or PDF produced by some word processors for +output purposes only. + +The ``Title Page'' means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, ``Title Page'' means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + +The ``publisher'' means any person or entity that distributes copies +of the Document to the public. + +A section ``Entitled XYZ'' means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as ``Acknowledgements'', +``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title'' +of such a section when you modify the Document means that it remains a +section ``Entitled XYZ'' according to this definition. + +The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. + +@item +VERBATIM COPYING + +You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no other +conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + +@item +COPYING IN QUANTITY + +If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document's license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. + +If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. + +If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. + +It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to give +them a chance to provide you with an updated version of the Document. + +@item +MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: + +@enumerate A +@item +Use in the Title Page (and on the covers, if any) a title distinct +from that of the Document, and from those of previous versions +(which should, if there were any, be listed in the History section +of the Document). You may use the same title as a previous version +if the original publisher of that version gives permission. + +@item +List on the Title Page, as authors, one or more persons or entities +responsible for authorship of the modifications in the Modified +Version, together with at least five of the principal authors of the +Document (all of its principal authors, if it has fewer than five), +unless they release you from this requirement. + +@item +State on the Title page the name of the publisher of the +Modified Version, as the publisher. + +@item +Preserve all the copyright notices of the Document. + +@item +Add an appropriate copyright notice for your modifications +adjacent to the other copyright notices. + +@item +Include, immediately after the copyright notices, a license notice +giving the public permission to use the Modified Version under the +terms of this License, in the form shown in the Addendum below. + +@item +Preserve in that license notice the full lists of Invariant Sections +and required Cover Texts given in the Document's license notice. + +@item +Include an unaltered copy of this License. + +@item +Preserve the section Entitled ``History'', Preserve its Title, and add +to it an item stating at least the title, year, new authors, and +publisher of the Modified Version as given on the Title Page. If +there is no section Entitled ``History'' in the Document, create one +stating the title, year, authors, and publisher of the Document as +given on its Title Page, then add an item describing the Modified +Version as stated in the previous sentence. + +@item +Preserve the network location, if any, given in the Document for +public access to a Transparent copy of the Document, and likewise +the network locations given in the Document for previous versions +it was based on. These may be placed in the ``History'' section. +You may omit a network location for a work that was published at +least four years before the Document itself, or if the original +publisher of the version it refers to gives permission. + +@item +For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve +the Title of the section, and preserve in the section all the +substance and tone of each of the contributor acknowledgements and/or +dedications given therein. + +@item +Preserve all the Invariant Sections of the Document, +unaltered in their text and in their titles. Section numbers +or the equivalent are not considered part of the section titles. + +@item +Delete any section Entitled ``Endorsements''. Such a section +may not be included in the Modified Version. + +@item +Do not retitle any existing section to be Entitled ``Endorsements'' or +to conflict in title with any Invariant Section. + +@item +Preserve any Warranty Disclaimers. +@end enumerate + +If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles. + +You may add a section Entitled ``Endorsements'', provided it contains +nothing but endorsements of your Modified Version by various +parties---for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. + +@item +COMBINING DOCUMENTS + +You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. + +The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. + +In the combination, you must combine any sections Entitled ``History'' +in the various original documents, forming one section Entitled +``History''; likewise combine any sections Entitled ``Acknowledgements'', +and any sections Entitled ``Dedications''. You must delete all +sections Entitled ``Endorsements.'' + +@item +COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other documents +released under this License, and replace the individual copies of this +License in the various documents with a single copy that is included in +the collection, provided that you follow the rules of this License for +verbatim copying of each of the documents in all other respects. + +You may extract a single document from such a collection, and distribute +it individually under this License, provided you insert a copy of this +License into the extracted document, and follow this License in all +other respects regarding verbatim copying of that document. + +@item +AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an ``aggregate'' if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation's users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document's Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. + +@item +TRANSLATION + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. + +If a section in the Document is Entitled ``Acknowledgements'', +``Dedications'', or ``History'', the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. + +@item +TERMINATION + +You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. + +@item +FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +@uref{http://www.gnu.org/copyleft/}. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License ``or any later version'' applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. + +@item +RELICENSING + +``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the +site means any set of copyrightable works thus published on the MMC +site. + +``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. + +``Incorporate'' means to publish or republish a Document, in whole or +in part, as part of another Document. + +An MMC is ``eligible for relicensing'' if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole +or in part into the MMC, (1) had no cover texts or invariant sections, +and (2) were thus incorporated prior to November 1, 2008. + +The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. + +@end enumerate + +@page +@heading ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + +@smallexample +@group + Copyright (C) @var{year} @var{your name}. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. A copy of the license is included in the section entitled ``GNU + Free Documentation License''. +@end group +@end smallexample + +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the ``with@dots{}Texts.''@: line with this: + +@smallexample +@group + with the Invariant Sections being @var{list their titles}, with + the Front-Cover Texts being @var{list}, and with the Back-Cover Texts + being @var{list}. +@end group +@end smallexample + +If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. + +@c Local Variables: +@c ispell-local-pdict: "ispell-dict" +@c End: diff --git a/doc/info/appx/free-software-needs-free-documentation.texinfo b/doc/info/appx/free-software-needs-free-documentation.texinfo new file mode 100644 index 0000000..8800993 --- /dev/null +++ b/doc/info/appx/free-software-needs-free-documentation.texinfo @@ -0,0 +1,31 @@ +@node Free Software Needs Free Documentation +@appendix Free Software Needs Free Documentation + +@indent +@i{The following article was written by Richard Stallman, founder of the GNU Project.} +@* + +@noindent +The biggest deficiency in the free software community today is not in the software --- it is the lack of good free documentation that we can include with the free software. Many of our most important programs do not come with free reference manuals and free introductory texts. Documentation is an essential part of any software package; when an important free software package does not come with a free manual and a free tutorial, that is a major gap. We have many such gaps today. + +Consider Perl, for instance. The tutorial manuals that people normally use are non-free. How did this come about? Because the authors of those manuals published them with restrictive terms --- no copying, no modification, source files not available --- which exclude them from the free software world. + +That wasn't the first time this sort of thing happened, and it was far from the last. Many times we have heard a @sc{GNU} user eagerly describe a manual that he is writing, his intended contribution to the community, only to learn that he had ruined everything by signing a publication contract to make it non-free. + +Free documentation, like free software, is a matter of freedom, not price. The problem with the non-free manual is not that publishers charge a price for printed copies --- that in itself is fine. (The Free Software Foundation sells printed copies of manuals, too.) The problem is the restrictions on the use of the manual. Free manuals are available in source code form, and give you permission to copy and modify. Non-free manuals do not allow this. + +The criteria of freedom for a free manual are roughly the same as for free software. Redistribution (including the normal kinds of commercial redistribution) must be permitted, so that the manual can accompany every copy of the program, both on-line and on paper. + +Permission for modification of the technical content is crucial too. When people modify the software, adding or changing features, if they are conscientious they will change the manual too --- so they can provide accurate and clear documentation for the modified program. A manual that leaves you no choice but to write a new manual to document a changed version of the program is not really available to our community. + +Some kinds of limits on the way modification is handled are acceptable. For example, requirements to preserve the original author's copyright notice, the distribution terms, or the list of authors, are ok. It is also no problem to require modified versions to include notice that they were modified. Even entire sections that may not be deleted or changed are acceptable, as long as they deal with nontechnical topics (like this one). These kinds of restrictions are acceptable because they don't obstruct the community's normal use of the manual. + +However, it must be possible to modify all the technical content of the manual, and then distribute the result in all the usual media, through all the usual channels. Otherwise, the restrictions obstruct the use of the manual, it is not free, and we need another manual to replace it. + +Please spread the word about this issue. Our community continues to lose manuals to proprietary publishing. If we spread the word that free software needs free reference manuals and free tutorials, perhaps the next person who wants to contribute by writing documentation will realize, before it is too late, that only free manuals contribute to the free software community. + +If you are writing documentation, please insist on publishing it under the @sc{GNU} Free Documentation License or another free documentation license. Remember that this decision requires your approval --- you don't have to let the publisher decide. Some commercial publishers will use a free license if you insist, but they will not propose the option; it is up to you to raise the issue and say firmly that this is what you want. If the publisher you are dealing with refuses, please try other publishers. If you're not sure whether a proposed license is free, write to licensing@@gnu.org. + +You can encourage commercial publishers to sell more free, copylefted manuals and tutorials by buying them, and particularly by buying copies from the publishers that paid for their writing or for major improvements. Meanwhile, try to avoid buying non-free documentation at all. Check the distribution terms of a manual before you buy it, and insist that whoever seeks your business must respect your freedom. Check the history of the book, and try reward the publishers that have paid or pay the authors to work on it. + +The Free Software Foundation maintains a list of free documentation published by other publishers, at @url{http://www.fsf.org/doc/other-free-books.html}. diff --git a/doc/info/chap/invoking.texinfo b/doc/info/chap/invoking.texinfo new file mode 100644 index 0000000..53fae77 --- /dev/null +++ b/doc/info/chap/invoking.texinfo @@ -0,0 +1,31 @@ +@node Invoking +@chapter Invoking + +@command{vtchs} ignores the command line +and the environment variables. You cannot +control its behaviour. + +However, it is required that standard input +is a @file{/dev/tty} device. If this programs +is running under root, +@example +vtchs < /dev/tty1 +@end example +@noindent +is sufficient. Non-root users need to find +a TTY that they have access to. If your +shell is GNU Bash, you can use +@example +vtchs < "/dev/tty$( i=1; + while true; do + if ! test -e /dev/tty$i; then + exit 1; + fi; + exec < /dev/tty$i && + echo $i && + exit 0 || + : $(( i++ )); + done 2>/dev/null + )" +@end example + diff --git a/doc/info/chap/overview.texinfo b/doc/info/chap/overview.texinfo new file mode 100644 index 0000000..937bfa9 --- /dev/null +++ b/doc/info/chap/overview.texinfo @@ -0,0 +1,9 @@ +@node Overview +@chapter Overview + +When @command{vtchs} starts, it prints the +number of the current console in the foreground. +Then, in an infinite loop, it waits for the user +to change console, and prints the number of the +new foregorund console when this happens. + diff --git a/doc/info/content.texinfo b/doc/info/content.texinfo new file mode 100644 index 0000000..cbe0031 --- /dev/null +++ b/doc/info/content.texinfo @@ -0,0 +1,28 @@ +@c This file includes everything after the titlepage. + + +@ifnothtml +@c @shortcontents @c (if the table of content gets too large.) +@contents +@end ifnothtml + + +@menu +* Overview:: Brief overview of @command{vtchs}. +* Invoking:: Invocation of @command{vtchs}. + +* Free Software Needs Free Documentation:: Why free documentation is important. +* GNU Free Documentation License:: Copying and sharing this manual. +@end menu +@c In GNU Emacs a @detailmenu can be created with `C-c C-u m`. + + +@include chap/overview.texinfo +@include chap/invoking.texinfo + +@include appx/free-software-needs-free-documentation.texinfo + +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include appx/fdl.texinfo + diff --git a/doc/info/hardcopy-copying.texinfo b/doc/info/hardcopy-copying.texinfo new file mode 100644 index 0000000..cd2a6cc --- /dev/null +++ b/doc/info/hardcopy-copying.texinfo @@ -0,0 +1,70 @@ +@c --- This is a template for the hardcopy-copying.texinfo file. --- + +@c Uncomment this when dead tree editions can be ordered. +@c @set HARDCOPY_AVAILABLE + + +@set PRINTINGNUMBER First +@set PRINTINGDATE Januari 0000 +@set ISBNNUMBER 0000000000 + +@ifset HARDCOPY +@copying +@ifset VERSION +This manual documents @value{programnamewiththe} version @value{VERSION}@. +@end ifset +@ifclear VERSION +This manual documents @value{programnamewiththe}. +@end ifclear +@* +@ifset EDITION +@sc{ISBN} @value{ISBNNUMBER}, @value{EDITION} Edition, @value{PRINTINGNUMBER} Printing, @value{PRINTINGDATE}. +@end ifset +@ifclear EDITION +@sc{ISBN} @value{ISBNNUMBER}, @value{PRINTINGNUMBER} Printing, @value{PRINTINGDATE}. +@end ifclear +@* + +Printed by: +@* + +X + +@*@* +Copyright @copyright{} 2015 Mattias Andrée @e{maandree@@member.fsf.org} +@* + +@c The copyright information from the main file, add any required +@c Invariant Sections being used on the dead tree edition. +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version@tie{}1.3 or +any later version published by the Free Software Foundation; +with the Invariant Sections being +``Free Software Needs Free Documentation'', +the ``GNU General Public License'', +the ``GNU Free Documentation License'', +with no Front-Cover Texts, +and with no Back-Cover Texts. +A copy of the license is included in the section entitled +``GNU Free Documentation License''. +@c THIS WAS LAST UPPDATE 2015-DECEMBER-17 UTC +@c AUTHORITATIVE COPYRIGHT INFORMATION IS AVAILABLE +@c IN vtchs.texinfo. THIS FILL MUST BE UPDATED +@c BEFORE PRINTING. + +@* +Cover art by XY Z. Cover design by XY Z. Printed in XYZ. +@end copying +@end ifset + + + +@ifclear HARDCOPY +@ifset HARDCOPY_AVAILABLE +@macro orderhardcopy{} +If you prefer a dead tree edition, you can order one from +... +@endif +@end ifset +@end ifclear + diff --git a/doc/info/reusable/macros.texinfo b/doc/info/reusable/macros.texinfo new file mode 100644 index 0000000..8d95983 --- /dev/null +++ b/doc/info/reusable/macros.texinfo @@ -0,0 +1,48 @@ +@c GENERAL ADVICE. +@c Because of an previous regression bug in Texinfo +@c it is a good idea to use @w around lines using +@c macros. + + +@c Use this comment to get a good looking e-mail +@c address in both the info output and the TeX +@c processed output. +@iftex +@macro e{a} +(@email{\a\}) +@end macro +@end iftex +@ifnottex +@macro e{a} +@email{\a\} +@end macro +@end ifnottex + +@c This is intented do be used inside @example. +@c At the beginning of non-code text in a source +@c code comment, use this macro to make it look +@c good in TeX processed output. End with @xtt. +@iftex +@macro xrm{} +@rm{} +@end macro +@end iftex +@ifnottex +@macro xrm{} +@end macro +@end ifnottex + +@c This is intented do be used inside @example. +@c At the end of non-code text in a source code +@c comment, use this macro to make it look +@c good in TeX processed output. +@iftex +@macro xtt{} +@tt{} +@end macro +@end iftex +@ifnottex +@macro xtt{} +@end macro +@end ifnottex + diff --git a/doc/info/reusable/paper.texinfo b/doc/info/reusable/paper.texinfo new file mode 100644 index 0000000..5a6aca8 --- /dev/null +++ b/doc/info/reusable/paper.texinfo @@ -0,0 +1,109 @@ +@c This file is used, by inclusion, to allow the +@c builder to specify how output shall be formatted. + +@c On dead tree editions we defailt to smallbook format. +@ifset HARDCOPY +@ifclear USLETTER +@ifclear AFOURPAPER +@ifclear AFIVEPAPER +@ifclear SMALLBOOK +@set SMALLBOOK +@end ifclear +@end ifclear +@end ifclear +@end ifclear +@end ifset + +@c On dead tree editions the heading on the left page +@c is different from the heading on the right page. +@c On online editions the heading is identical on the +@c left pages and on the right pages. +@ifclear SINGLE_HEADINGS +@ifclear DOUBLE_HEADINGS +@ifclear HARDCOPY +@set SINGLE_HEADINGS +@end ifclear +@ifset HARDCOPY +@set DOUBLE_HEADINGS +@end ifset +@end ifclear +@end ifclear + +@c Apply paper format. Default to A4. (Remember +@c dead tree editions defaulted to smallbook.) +@ifset AFIVEPAPER +@afivepaper +@end ifset +@ifset SMALLBOOK +@smallbook +@end ifset +@ifclear AFIVEPAPER +@ifclear SMALLBOOK +@ifclear USLETTER +@afourpaper +@set AFOURPAPER +@end ifclear +@end ifclear +@end ifclear +@c (Texinfo defaults to US letter, thus nothing is +@c done for USLETTER.) + +@c Only on dead tree editions: optionally add +@c cropmarks, and by default, chapters begin +@c on odd page numbers (the right side.) +@ifset HARDCOPY +@ifset CROPMARKS +@cropmarks +@end ifset +@ifclear SKIPCHAPTERNEWPAGE +@setchapternewpage odd +@end ifclear +@end ifset + +@c Apply font size. On smallbook and A5 default to +@c 10 points, on A4 and US letter we default to +@c 11 points. +@ifclear SKIPFONTTEXTSIZE +@ifset SMALLBOOK +@set SMALLFONT +@end ifset +@ifset AFIVEPAPER +@set SMALLFONT +@end ifset +@end ifclear +@ifset SMALLFONT +@fonttextsize 10 +@end ifset +@ifclear SMALLFONT +@iftex @c Because of bug in Texinfo<=4.13 +@fonttextsize 11 +@end iftex +@end ifclear + +@c In America it is customary to have two spaces after +@c a period. It is not elsewhere. (@frenchspacing is a +@c misnomer) +@ifclear AMERICANSPACING +@frenchspacing on +@end ifclear + +@c This should only be used when writting the document. +@c It is used to locate overflows. It should be be used +@c in a printed version. It can be used in an online come +@c use users can easier detect overflows and report them. +@ifclear NOFINALOUT +@finalout +@end ifclear + + +@c Call this macro after the title page, but before the +@c table of content, or the short table of content. +@macro setheadings{} +@ifset DOUBLEHEADINGS +@headings double +@end ifset +@ifset SINGLEHEADINGS +@headings single +@end ifset +@end macro + diff --git a/doc/info/reusable/titlepage.texinfo b/doc/info/reusable/titlepage.texinfo new file mode 100644 index 0000000..55981f7 --- /dev/null +++ b/doc/info/reusable/titlepage.texinfo @@ -0,0 +1,79 @@ +@c This file @top or @titlepage. + +@ifnottex +@node Top +@top @value{title} -- @value{subtitle} +@insertcopying +@end ifnottex + +@titlepage +@title @value{title} +@subtitle @value{subtitle} + +@c Date, edition, and version of the program. +@c Should be set on dead tree editions. Not too +@c important on online editions. +@ifset DATE +@ifset VERSION +@ifset EDITION +@subtitle @value{DATE}, @value{programname} version@tie{}@value{VERSION}, @value{EDITION} edition +@end ifset +@ifclear EDITION +@subtitle @value{DATE}, @value{programname} version@tie{}@value{VERSION} +@end ifclear +@end ifset +@ifclear VERSION +@ifset EDITION +@subtitle @value{DATE}, @value{EDITION} edition +@end ifset +@ifclear EDITION +@subtitle @value{DATE} +@end ifclear +@end ifclear +@end ifset +@ifclear DATE +@ifset VERSION +@ifset EDITION +@subtitle @value{programname} version@tie{}@value{VERSION}, @value{EDITION} edition +@end ifset +@ifclear EDITION +@subtitle @value{programname} version@tie{}@value{VERSION} +@end ifclear +@end ifset +@ifclear VERSION +@ifset EDITION +@subtitle @value{EDITION} edition +@end ifset +@end ifclear +@end ifclear + +@ifset LOGO +@vskip 0pt plus 1filll +@c This way, it is centered exactly in pdf and approximently +@c in dvi and ps. @center does not work for @image in dvi and ps. +@multitable @columnfractions 0.15 0.7 +@item @tab @center @image{../logo,250px} +@end multitable +@vskip 0pt plus 2filll +@end ifset +@authors{} + +@page +@ifset HARDCOPY +@vskip 0pt plus 1filll +@insertcopying +@page +@end ifset +@ifset HAVE_DEDICATION +@dedication{} +@end ifset +@ifclear HARDCOPY +@vskip 0pt plus 1filll +@ifset HARDCOPY_AVAILABLE +@orderhardcopy{} +@* +@end ifset +@insertcopying +@end ifclear +@end titlepage + diff --git a/doc/info/titlepage-data.texinfo b/doc/info/titlepage-data.texinfo new file mode 100644 index 0000000..bf6bd3f --- /dev/null +++ b/doc/info/titlepage-data.texinfo @@ -0,0 +1,23 @@ +@c The title and the subtitle of the manual. +@set title vtchs +@set subtitle Listen for VT switches + +@c The full name of the documented program or package. +@set programname @command{vtchs} +@set programnamewiththe @command{vtchs} + + +@c Authors of the manual. Included at the bottom +@c of the titlepage on TeX processed output. +@macro authors{} +@author by Mattias Andrée (maandree) +@end macro + + +@c Dedication for TeX processed output. +@c @set HAVE_DEDICATION +@c @macro dedication{} +@c @center `' +@c @end macro +@c (I don't use dedications, I use quotes.) + diff --git a/doc/info/vtchs.texinfo b/doc/info/vtchs.texinfo new file mode 100644 index 0000000..d9a92fc --- /dev/null +++ b/doc/info/vtchs.texinfo @@ -0,0 +1,104 @@ +\input texinfo @c -*-texinfo-*- +@c %**start of header +@documentencoding UTF-8 +@include reusable/macros.texinfo +@copying +@c -------------------------------------------------------------------------------- +Copyright @copyright{} 2015 @w{Mattias Andrée @e{maandree@@member.fsf.org}} + +@quotation +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version@tie{}1.3 or +any later version published by the Free Software Foundation; with the +Invariant Sections being ``Free Software Needs Free Documentation'', the +``GNU General Public License'', the ``GNU Free Documentation License'', +with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the +license is included in the section entitled ``GNU Free Documentation License''. +@end quotation +@c THIS WAS LAST CHANGED 2015-DECEMBER-17 UTC +@c When updated, please remember to update hardcopy-copying.texinfo too. +@c -------------------------------------------------------------------------------- +@end copying + +@setfilename vtchs.info +@settitle vtchs +@documentlanguage en_GB +@include titlepage-data.texinfo + +@c You can change the title of the document in dir by compiling with +@c TEXINFO_FLAGS='--texinfo="@set CATEGORY your_new_category"' +@ifclear CATEGORY +@set CATEGORY Miscellaneous +@end ifclear + +@dircategory @value{CATEGORY} +@direntry +* vtchs: (vtchs). @value{subtitle} +@end direntry + +@documentdescription +User manual for vtchs. +A daemon that prints the active console +when the console is switched. +@end documentdescription +@c %**end of header + + +@iftex +@c @set USLETTER +@c @set AFOURPAPER +@c @set AFIVEPAPER +@c @set SMALLBOOK + +@c @set HARDCOPY +@c @set CROPMARKS +@c @set SKIPCHAPTERNEWPAGE +@c @set SKIPFONTTEXTSIZE +@end iftex +@c @set LOGO +@c @set DOUBLEHEADINGS +@c @set SINGLEHEADINGS +@c @set AMERICANSPACING +@c @set NOFINALOUT + +@ignore + + CROPMARKS has no effect unless HARDCOPY is set. CROPMARKS + and AFIVEPAPER (or actually @cropmarks and @afivepaper) does + not play well together. + + You can configure how TeX output files should look by uncommenting + @set commands above. Do not uncomment more than one of the paper + sizes (USLETTER, AFOURPAPER, AFIVEPAPER and SMALLBOOK); if none is + uncomment AFOURPAPER will be set unless HARDCOPY is set, in which + case SMALLBOOK will be set. However, if you do not want to modify + this source file, you can run `make` with for example + `TEXINFO_FLAGS='--texinfo="@set HARDCOPY"'`. + + Finally, you can include, on the front page, the version of vtchs + that the manual is up to date with, by setting the value of VERSION + to the version of vtchs, as well as date of the last update by + setting DATE, and edition by setting EDITION. This is intended for + printed manuals. The date is recommended to not be more accurate, + or less accurate, than to the month. The edition should be formatted + as, for example, ``1@sup{st}''. + +@end ignore + +@comment You can see these too with TEXINFO_FLAGS. +@c @paragraphindent asis +@c @firstparagraphindent none +@c @exampleindent asis +@c @kbdinputstyle distinct + +@include reusable/paper.texinfo + + +@include hardcopy-copying.texinfo +@include reusable/titlepage.texinfo +@setheadings{} + +@include content.texinfo + +@bye + |