diff options
Diffstat (limited to 'doc/info')
| -rw-r--r-- | doc/info/appx/fdl.texinfo (renamed from doc/info/fdl.texinfo) | 0 | ||||
| -rw-r--r-- | doc/info/appx/free-software-needs-free-documentation.texinfo | 31 | ||||
| -rw-r--r-- | doc/info/appx/gpl.texinfo | 717 | ||||
| -rw-r--r-- | doc/info/chap/invoking.texinfo | 87 | ||||
| -rw-r--r-- | doc/info/chap/overview.texinfo | 20 | ||||
| -rw-r--r-- | doc/info/chap/strftime.texinfo | 161 | ||||
| -rw-r--r-- | doc/info/content.texinfo | 33 | ||||
| -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 | 107 | ||||
| -rw-r--r-- | doc/info/reusable/titlepage.texinfo | 77 | ||||
| -rw-r--r-- | doc/info/scrotty.texinfo | 409 | ||||
| -rw-r--r-- | doc/info/titlepage-data.texinfo | 24 |
13 files changed, 1460 insertions, 324 deletions
diff --git a/doc/info/fdl.texinfo b/doc/info/appx/fdl.texinfo index cb71f05..cb71f05 100644 --- a/doc/info/fdl.texinfo +++ b/doc/info/appx/fdl.texinfo 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/appx/gpl.texinfo b/doc/info/appx/gpl.texinfo new file mode 100644 index 0000000..c773b1d --- /dev/null +++ b/doc/info/appx/gpl.texinfo @@ -0,0 +1,717 @@ +@c The GNU General Public License. +@center Version 3, 29 June 2007 + +@c This file is intended to be included within another document, +@c hence no sectioning command or @node. + +@display +Copyright @copyright{} 2007 Free Software Foundation, Inc. @url{http://fsf.org/} + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. +@end display + +@heading Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program---to make sure it remains +free software for all its users. We, the Free Software Foundation, +use the GNU General Public License for most of our software; it +applies also to any other work released this way by its authors. You +can apply it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, +receive or can get the source code. And you must show them these +terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +@heading TERMS AND CONDITIONS + +@enumerate 0 +@item Definitions. + +``This License'' refers to version 3 of the GNU General Public License. + +``Copyright'' also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +``The Program'' refers to any copyrightable work licensed under this +License. Each licensee is addressed as ``you''. ``Licensees'' and +``recipients'' may be individuals or organizations. + +To ``modify'' a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a ``modified version'' of +the earlier work or a work ``based on'' the earlier work. + +A ``covered work'' means either the unmodified Program or a work based +on the Program. + +To ``propagate'' a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To ``convey'' a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays ``Appropriate Legal Notices'' to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +@item Source Code. + +The ``source code'' for a work means the preferred form of the work for +making modifications to it. ``Object code'' means any non-source form +of a work. + +A ``Standard Interface'' means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The ``System Libraries'' of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +``Major Component'', in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The ``Corresponding Source'' for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +@item Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + +@item Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +@item Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +@item Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +@enumerate a +@item +The work must carry prominent notices stating that you modified it, +and giving a relevant date. + +@item +The work must carry prominent notices stating that it is released +under this License and any conditions added under section 7. This +requirement modifies the requirement in section 4 to ``keep intact all +notices''. + +@item +You must license the entire work, as a whole, under this License to +anyone who comes into possession of a copy. This License will +therefore apply, along with any applicable section 7 additional terms, +to the whole of the work, and all its parts, regardless of how they +are packaged. This License gives no permission to license the work in +any other way, but it does not invalidate such permission if you have +separately received it. + +@item +If the work has interactive user interfaces, each must display +Appropriate Legal Notices; however, if the Program has interactive +interfaces that do not display Appropriate Legal Notices, your work +need not make them do so. +@end enumerate + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +``aggregate'' if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +@item Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +@enumerate a +@item +Convey the object code in, or embodied in, a physical product +(including a physical distribution medium), accompanied by the +Corresponding Source fixed on a durable physical medium customarily +used for software interchange. + +@item +Convey the object code in, or embodied in, a physical product +(including a physical distribution medium), accompanied by a written +offer, valid for at least three years and valid for as long as you +offer spare parts or customer support for that product model, to give +anyone who possesses the object code either (1) a copy of the +Corresponding Source for all the software in the product that is +covered by this License, on a durable physical medium customarily used +for software interchange, for a price no more than your reasonable +cost of physically performing this conveying of source, or (2) access +to copy the Corresponding Source from a network server at no charge. + +@item +Convey individual copies of the object code with a copy of the written +offer to provide the Corresponding Source. This alternative is +allowed only occasionally and noncommercially, and only if you +received the object code with such an offer, in accord with subsection +6b. + +@item +Convey the object code by offering access from a designated place +(gratis or for a charge), and offer equivalent access to the +Corresponding Source in the same way through the same place at no +further charge. You need not require recipients to copy the +Corresponding Source along with the object code. If the place to copy +the object code is a network server, the Corresponding Source may be +on a different server (operated by you or a third party) that supports +equivalent copying facilities, provided you maintain clear directions +next to the object code saying where to find the Corresponding Source. +Regardless of what server hosts the Corresponding Source, you remain +obligated to ensure that it is available for as long as needed to +satisfy these requirements. + +@item +Convey the object code using peer-to-peer transmission, provided you +inform other peers where the object code and Corresponding Source of +the work are being offered to the general public at no charge under +subsection 6d. + +@end enumerate + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A ``User Product'' is either (1) a ``consumer product'', which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +``normally used'' refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +``Installation Information'' for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +@item Additional Terms. + +``Additional permissions'' are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +@enumerate a +@item +Disclaiming warranty or limiting liability differently from the terms +of sections 15 and 16 of this License; or + +@item +Requiring preservation of specified reasonable legal notices or author +attributions in that material or in the Appropriate Legal Notices +displayed by works containing it; or + +@item +Prohibiting misrepresentation of the origin of that material, or +requiring that modified versions of such material be marked in +reasonable ways as different from the original version; or + +@item +Limiting the use for publicity purposes of names of licensors or +authors of the material; or + +@item +Declining to grant rights under trademark law for use of some trade +names, trademarks, or service marks; or + +@item +Requiring indemnification of licensors and authors of that material by +anyone who conveys the material (or modified versions of it) with +contractual assumptions of liability to the recipient, for any +liability that these contractual assumptions directly impose on those +licensors and authors. +@end enumerate + +All other non-permissive additional terms are considered ``further +restrictions'' within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +@item Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +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, you do not qualify to receive new licenses for the same +material under section 10. + +@item Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +@item Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An ``entity transaction'' is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +@item Patents. + +A ``contributor'' is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's ``contributor version''. + +A contributor's ``essential patent claims'' are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, ``control'' includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a ``patent license'' is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To ``grant'' such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. ``Knowingly relying'' means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is ``discriminatory'' if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +@item No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey +a covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree +to terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +@item Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +@item Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public 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. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License ``or any later version'' applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If +the Program does not specify a version number of the GNU General +Public License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +@item Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW@. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM ``AS IS'' WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE@. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU@. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION@. + +@item Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES@. + +@item Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +@end enumerate + +@heading END OF TERMS AND CONDITIONS + +@heading How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the ``copyright'' line and a pointer to where the full notice is found. + +@smallexample +@var{one line to give the program's name and a brief idea of what it does.} +Copyright (C) @var{year} @var{name of author} + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or (at +your option) any later version. + +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see @url{http://www.gnu.org/licenses/}. +@end smallexample + +Also add information on how to contact you by electronic and paper mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + +@smallexample +@var{program} Copyright (C) @var{year} @var{name of author} +This program comes with ABSOLUTELY NO WARRANTY; for details type @samp{show w}. +This is free software, and you are welcome to redistribute it +under certain conditions; type @samp{show c} for details. +@end smallexample + +The hypothetical commands @samp{show w} and @samp{show c} should show +the appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an ``about box''. + +You should also get your employer (if you work as a programmer) or school, +if any, to sign a ``copyright disclaimer'' for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +@url{http://www.gnu.org/licenses/}. + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use +the GNU Lesser General Public License instead of this License. But +first, please read @url{http://www.gnu.org/philosophy/why-not-lgpl.html}. diff --git a/doc/info/chap/invoking.texinfo b/doc/info/chap/invoking.texinfo new file mode 100644 index 0000000..25c0b25 --- /dev/null +++ b/doc/info/chap/invoking.texinfo @@ -0,0 +1,87 @@ +@node Invoking +@chapter Invoking + +@command{scrotty} recognises four options: + +@table @option +@item --help +Print usage information and exit. +@item --version +Print program name and version and exit. +@item --copyright +Print copyright information and exit. +@item --raw +Save the images in portable anymap format +(PNM), rather than in Portable Network +Graphics (PNG). If this option is used, +and no arguments for @command{convert} +is specified, @command{convert} will not +be used, and there will be not requirement +to have ImageMagick installed. + +PNM images are highly compressable with +@command{bzip2}. Compressed images are comparable +in size with @sc{PNG},@footnote{Usually a few +bytes in difference.} and can in fact be smaller. +@item --exec CMD +Run a command for each saved image. +@end table + +In addition to these options, a filename +pattern, that does not start with a dash, +can be added. This filename pattern selects +with what filename the image should be saved. + +Further, it is possible add @option{--} +followed by additional options to add when +@command{scrotty} spawns @command{convert}. + +Both the @option{--exec} and filename pattern +parameters can take format specifiers that are +expanded by @command{scrotty} when encountered. +There are two types of format specifier. +Characters preceded by a `%' are interpreted +by @code{strftime}. See @ref{strftime} or the +manual for your implemenation of @command{strftime} +for examples. These options may be used to refer +to the current date and time. The second kind are +internal to scrotty and are prefixed by `$' or +`\'. The following specifiers are recognised: + +@table @asis +@item `@code{$i}' +Framebuffer index. +@item `@code{$f}' +Image filename/pathname. +Ignored in the filename pattern. +@item `@code{$n}' +Image filename. +Ignored in the filename pattern. +@item `@code{$p}' +Image width multiplied by image height. +@item `@code{$w}' +Image width. +@item `@code{$h}' +Image height. +@item `@code{$$}' +Expands to a literal `$'. +@item `@code{\n}' +Expands to new line. +@item `@code{\\}' +Expands to a literal `\'. +@item `@code{\ }' +Expands to a literal ` '. +@end table + +A space that is not prefixed by a backslash in +@option{--exec} is interpreted as an argument +delimiter. This is the case even at the beginning +and end of the string and if a space was the +previous character in the string. + +For example, +@command{scrotty `%Y-%m-%d_$wx$h.$i.png` --exec 'cp $f ~/.backups/shots/'} +create a file called something like @file{2014-10-28_1792x1344.0.png} +for your first framebuffer and @file{2014-10-28_1792x1344.1.png} for +your second framebuffer, and copies the saved images to @file{~/.backups/shots/}. + diff --git a/doc/info/chap/overview.texinfo b/doc/info/chap/overview.texinfo new file mode 100644 index 0000000..f5d1ff3 --- /dev/null +++ b/doc/info/chap/overview.texinfo @@ -0,0 +1,20 @@ +@node Overview +@chapter Overview + +@command{scrotty} is a simple command for taking a screenshot +of your framebuffers. It can be used to take a screenshot of +your @sc{TTY} session, but it cannot take a screenshot of your +@sc{X} session.@footnote{Unless it is for some reason is +rendered on the framebuffer.} + +@command{scrotty} is designed after @command{scrot}, but +includes a some improvements. Namely it does not support +delaying the screenshot, selecting image quality or creating +thumbnails, but it has support for adding arbitrary arguments +to @command{convert} (from the ImageMagick project), which +is used to save the image. + +@command{scrotty} reads the data stored in the framebuffers, +convert it the @sc{PNM} images and pipes it to @command{convert} +to create @sc{PNG} images. + diff --git a/doc/info/chap/strftime.texinfo b/doc/info/chap/strftime.texinfo new file mode 100644 index 0000000..49fa224 --- /dev/null +++ b/doc/info/chap/strftime.texinfo @@ -0,0 +1,161 @@ +@node strftime +@chapter @code{strftime} + +@command{scrotty} uses @code{strftime}, which +implemented by the @sc{C} standard library (the +@sc{GNU} @sc{C} Library for most @sc{GNU}/Linux +user,) for formatting the filename or commands +with information about the current date and time. +If you are using the @sc{GNU} @sc{C} Library, +full documentation is available in +@ref{Formatting Calendar Time, Formatting Calendar Time, Formatting Calendar Time, libc, GNU C Library Application Fundamentals}. + +Assuming your have a @sc{POSIX}-compliant +implementation of @code{strftime}, at least the +following formatters are supported: + +@table @code +@item %a +The name of weekday in your locale, abbreviated. +For example `Tue'. +@item %A +The name of weekday in your locale. For example +`Tuesday'. +@item %b +@itemx %h +The name of month in your locale, abbreviated. +For example `Dec'. +@item %B +The name of month in your locale. For example +`December. +@item %c +Your locale's representation for the date and +time. For example `Tue 08 Dec 2015 09:40:34 CET'. +@item %C +The ``century'', or more precisely the year +divided by 100 and trucated to an integer. +Between year 2000 and 2099, inclusively, this +will be `20'. +@item %d +The day of the month in two digits. For example, +`08' during 8 of December. +@item %D +Equivalent to @code{%m/%d/%y}. For example +@code{12/08/15} for 8 of December 2015. + +Be aware, this not what expect in most of the +World, and its requires specialised sorting +algorithms to be sorted properly. Be also +aware, that this contains forward slashes, which +is used as the file delimiter. This is a poor +idea to use this for the filename. @code{%F} +is a better choice. +@item %e +The day of the month. If only one digit is +required, it is preceded by a space. For +example, ` 8' during 8 of December. +@item %F +Equivalent to @code{%+4Y-%m-%d}. For example +@code{2015-12-08} for 8 of December 2015. +@item %g +The last 2 digits of the week-based year. +@item %G +The week-based year. +@item %H +The hour in 24-hour clock format, 2 digits. +@item %-H +The hour in 24-hour clock format, as few digits as possible. +@item %I +The hour in 12-hour clock format, 2 digits. +@item %-I +The hour in 12-hour clock format, as few digits as possible. +@item %j +The day of the year in 3 digits. +For example @code{342} for 8 of December 2015. +@item %-j +The day of the year in as few digits as possible. +@item %m +The month in 2 digits. +For example @code{12} for 8 of December 2015. +@item %-m +The month in as few digits as possible. +@item %M +The minute in 2 digits. +@item %n +A new line. +@item %p +The locale's repesentation for either ante +meridiem or post meridiem. +@item %r +The time in 12-hour notation. The behaviour +is not completely specified. You will have +to try it out. It will probably include +the second and the timezone. +@item %R +The time, in minute resolution, in 24-hour +notation.@footnote{Yes, this is barely similar to +@code{%r}.} +@item %S +The second, in too digits. Currently leap-seconds +are not supported, and @sc{POSIX} does not specify +that double positive leap-seconds are +possible@footnote{Probably because they are avoided.}. +@item %t +A tab space. +@item %T +Equivalent to @code{%H:%M:%S}. +@item %u +The weekday as a number, starting with Monday as 1. +@item %U +The week number of the year, 2 digits. +The first Sunday of January is the first day of +week 1. Week 0 is possible. +@item %-U +Equivalent to @code{-U}, except in as few digits +as possible. +@item %V +The week number of the year, 2 digits. +IF week containing 1 of January has at least four +days in the new year, it is week 1. Week 0 is +impossible. +@item %-V +Equivalent to @code{-V}, except in as few digits +as possible. +@item %w +The weekday as a number, starting with Sunday as 0. +@item %W +The week number of the year, 2 digits. +The first Monday of January is the first day of +week 1. Week 0 is possible. +@item %-W +Equivalent to @code{-W}, except in as few digits +as possible. +@item %x +The locale's representation of the date. This +may be equivalent or similar to @code{%F} and +thus a poor idea to use, if so. +@item %X +The locale's representation of the time. +@item %y +The last two digits in the year. (And at least two digits.) +@item %Y +The year with as many digits as necessary. +@item %z +The offset of the timezone from UTC. Either +@code{+hhmm} or @code{-hhmm} (starts with a hyphen.) +@item %Z +The name of the timezone, abbreviation. +@item %% +A literal `%'. +@end table + +Note, this is not all that @sc{POSIX} specifies, +but it is the basics. @sc{POSIX} does not specify +any support for 6-hour clocks, for Saturday as the +first day of the week (or Tuesay through Friday,) or +Sunday to be represented by 1 or Monday as 0. If you +need any of these, you should look into the +specifications for your @sc{C} standard libraries +implementation of @code{strftime}, which may or may +nor support this. + diff --git a/doc/info/content.texinfo b/doc/info/content.texinfo new file mode 100644 index 0000000..9617f69 --- /dev/null +++ b/doc/info/content.texinfo @@ -0,0 +1,33 @@ +@c This file includes everything after the titlepage. + + +@c @shortcontents @c (if the table of content gets too large.) +@contents + + +@menu +* Overview:: Brief overview of @command{scrotty}. +* Invoking:: Invocation of @command{scrotty}. +* strftime:: Syntax support via @code{strftime}. + +* Free Software Needs Free Documentation:: Why free documentation is important. +* GNU General Public License:: Copying and sharing @command{scrotty}. +* 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 chap/strftime.texinfo + +@include appx/free-software-needs-free-documentation.texinfo + +@node GNU General Public License +@appendix GNU General Public License +@include appx/gpl.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..45c7fcf --- /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{} 2014, 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-08 UTC +@c AUTHORITATIVE COPYRIGHT INFORMATION IS AVAILABLE +@c IN scrotty.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..1fc9f0f --- /dev/null +++ b/doc/info/reusable/paper.texinfo @@ -0,0 +1,107 @@ +@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 +@fonttextsize 11 +@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..0f3d553 --- /dev/null +++ b/doc/info/reusable/titlepage.texinfo @@ -0,0 +1,77 @@ +@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 +@dedication{} +@ifclear HARDCOPY +@vskip 0pt plus 1filll +@ifset HARDCOPY_AVAILABLE +@orderhardcopy{} +@* +@end ifset +@insertcopying +@end ifclear +@end titlepage + diff --git a/doc/info/scrotty.texinfo b/doc/info/scrotty.texinfo index c26100e..7fa7477 100644 --- a/doc/info/scrotty.texinfo +++ b/doc/info/scrotty.texinfo @@ -1,342 +1,103 @@ \input texinfo @c -*-texinfo-*- - @c %**start of header -@setfilename scrotty.info -@settitle scrotty -@afourpaper @documentencoding UTF-8 -@documentlanguage en -@finalout -@c %**end of header - - -@dircategory Multimedia -@direntry -* scrotty: (scrotty). Take a screenshot of the framebuffer -@end direntry - - +@include reusable/macros.texinfo @copying -Copyright @copyright{} 2014, 2015 Mattias Andrée +@c -------------------------------------------------------------------------------- +Copyright @copyright{} 2014, 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 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, 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''. +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-08 UTC +@c When updated, please remember to update hardcopy-copying.texinfo too. +@c -------------------------------------------------------------------------------- @end copying -@ifnottex -@node Top -@top scrotty -- Take a screenshot of the framebuffer -@insertcopying -@end ifnottex - -@titlepage -@title scrotty -@subtitle Take a screenshot of the framebuffer -@author by Mattias Andrée (maandree) - -@page -@center `I don't know how to make a screenshot, because I normally use my computer in -@center text-mode. I have @sc{X} and @sc{GNOME} installed, but I use them only occasionally.' --- rms -@vskip 0pt plus 1filll -@insertcopying -@end titlepage - -@contents - - - -@menu -* Overview:: Brief overview of @command{scrotty}. -* Invoking:: Invocation of @command{scrotty}. -* strftime:: Syntax support via @code{strftime}. -* GNU Free Documentation License:: Copying and sharing this manual. -@end menu - - - -@node Overview -@chapter Overview - -@command{scrotty} is a simple command for taking a screenshot -of your framebuffers. It can be used to take a screenshot of -your @sc{TTY} session, but it cannot take a screenshot of your -@sc{X} session.@footnote{Unless it is for some reason is -rendered on the framebuffer.} - -@command{scrotty} is designed after @command{scrot}, but -includes a some improvements. Namely it does not support -delaying the screenshot, selecting image quality or creating -thumbnails, but it has support for adding arbitrary arguments -to @command{convert} (from the ImageMagick project), which -is used to save the image. - -@command{scrotty} reads the data stored in the framebuffers, -convert it the @sc{PNM} images and pipes it to @command{convert} -to create @sc{PNG} images. - - - -@node Invoking -@chapter Invoking - -@command{scrotty} recognises four options: - -@table @option -@item --help -Print usage information and exit. -@item --version -Print program name and version and exit. -@item --copyright -Print copyright information and exit. -@item --raw -Save the images in portable anymap format -(PNM), rather than in Portable Network -Graphics (PNG). If this option is used, -and no arguments for @command{convert} -is specified, @command{convert} will not -be used, and there will be not requirement -to have ImageMagick installed. - -PNM images are highly compressable with -@command{bzip2}. Compressed images are comparable -in size with @sc{PNG},@footnote{Usually a few -bytes in difference.} and can in fact be smaller. -@item --exec CMD -Run a command for each saved image. -@end table - -In addition to these options, a filename -pattern, that does not start with a dash, -can be added. This filename pattern selects -with what filename the image should be saved. - -Further, it is possible add @option{--} -followed by additional options to add when -@command{scrotty} spawns @command{convert}. - -Both the @option{--exec} and filename pattern -parameters can take format specifiers that are -expanded by @command{scrotty} when encountered. -There are two types of format specifier. -Characters preceded by a `%' are interpreted -by @code{strftime}. See @ref{strftime} or the -manual for your implemenation of @command{strftime} -for examples. These options may be used to refer -to the current date and time. The second kind are -internal to scrotty and are prefixed by `$' or -`\'. The following specifiers are recognised: - -@table @asis -@item `@code{$i}' -Framebuffer index. -@item `@code{$f}' -Image filename/pathname. -Ignored in the filename pattern. -@item `@code{$n}' -Image filename. -Ignored in the filename pattern. -@item `@code{$p}' -Image width multiplied by image height. -@item `@code{$w}' -Image width. -@item `@code{$h}' -Image height. -@item `@code{$$}' -Expands to a literal `$'. -@item `@code{\n}' -Expands to new line. -@item `@code{\\}' -Expands to a literal `\'. -@item `@code{\ }' -Expands to a literal ` '. -@end table - -A space that is not prefixed by a backslash in -@option{--exec} is interpreted as an argument -delimiter. This is the case even at the beginning -and end of the string and if a space was the -previous character in the string. - -For example, -@command{scrotty `%Y-%m-%d_$wx$h.$i.png` --exec 'cp $f ~/.backups/shots/'} -create a file called something like @file{2014-10-28_1792x1344.0.png} -for your first framebuffer and @file{2014-10-28_1792x1344.1.png} for -your second framebuffer, and copies the saved images to @file{~/.backups/shots/}. - - - -@node strftime -@chapter @code{strftime} - -@command{scrotty} uses @code{strftime}, which -implemented by the @sc{C} standard library (the -@sc{GNU} @sc{C} Library for most @sc{GNU}/Linux -user,) for formatting the filename or commands -with information about the current date and time. -If you are using the @sc{GNU} @sc{C} Library, -full documentation is available in -@ref{Formatting Calendar Time, Formatting Calendar Time, Formatting Calendar Time, libc, GNU C Library Application Fundamentals}. - -Assuming your have a @sc{POSIX}-compliant -implementation of @code{strftime}, at least the -following formatters are supported: - -@table @code -@item %a -The name of weekday in your locale, abbreviated. -For example `Tue'. -@item %A -The name of weekday in your locale. For example -`Tuesday'. -@item %b -@itemx %h -The name of month in your locale, abbreviated. -For example `Dec'. -@item %B -The name of month in your locale. For example -`December. -@item %c -Your locale's representation for the date and -time. For example `Tue 08 Dec 2015 09:40:34 CET'. -@item %C -The ``century'', or more precisely the year -divided by 100 and trucated to an integer. -Between year 2000 and 2099, inclusively, this -will be `20'. -@item %d -The day of the month in two digits. For example, -`08' during 8 of December. -@item %D -Equivalent to @code{%m/%d/%y}. For example -@code{12/08/15} for 8 of December 2015. +@setfilename scrotty.info +@settitle scrotty +@documentlanguage en_GB +@include titlepage-data.texinfo -Be aware, this not what expect in most of the -World, and its requires specialised sorting -algorithms to be sorted properly. Be also -aware, that this contains forward slashes, which -is used as the file delimiter. This is a poor -idea to use this for the filename. @code{%F} -is a better choice. -@item %e -The day of the month. If only one digit is -required, it is preceded by a space. For -example, ` 8' during 8 of December. -@item %F -Equivalent to @code{%+4Y-%m-%d}. For example -@code{2015-12-08} for 8 of December 2015. -@item %g -The last 2 digits of the week-based year. -@item %G -The week-based year. -@item %H -The hour in 24-hour clock format, 2 digits. -@item %-H -The hour in 24-hour clock format, as few digits as possible. -@item %I -The hour in 12-hour clock format, 2 digits. -@item %-I -The hour in 12-hour clock format, as few digits as possible. -@item %j -The day of the year in 3 digits. -For example @code{342} for 8 of December 2015. -@item %-j -The day of the year in as few digits as possible. -@item %m -The month in 2 digits. -For example @code{12} for 8 of December 2015. -@item %-m -The month in as few digits as possible. -@item %M -The minute in 2 digits. -@item %n -A new line. -@item %p -The locale's repesentation for either ante -meridiem or post meridiem. -@item %r -The time in 12-hour notation. The behaviour -is not completely specified. You will have -to try it out. It will probably include -the second and the timezone. -@item %R -The time, in minute resolution, in 24-hour -notation.@footnote{Yes, this is barely similar to -@code{%r}.} -@item %S -The second, in too digits. Currently leap-seconds -are not supported, and @sc{POSIX} does not specify -that double positive leap-seconds are -possible@footnote{Probably because they are avoided.}. -@item %t -A tab space. -@item %T -Equivalent to @code{%H:%M:%S}. -@item %u -The weekday as a number, starting with Monday as 1. -@item %U -The week number of the year, 2 digits. -The first Sunday of January is the first day of -week 1. Week 0 is possible. -@item %-U -Equivalent to @code{-U}, except in as few digits -as possible. -@item %V -The week number of the year, 2 digits. -IF week containing 1 of January has at least four -days in the new year, it is week 1. Week 0 is -impossible. -@item %-V -Equivalent to @code{-V}, except in as few digits -as possible. -@item %w -The weekday as a number, starting with Sunday as 0. -@item %W -The week number of the year, 2 digits. -The first Monday of January is the first day of -week 1. Week 0 is possible. -@item %-W -Equivalent to @code{-W}, except in as few digits -as possible. -@item %x -The locale's representation of the date. This -may be equivalent or similar to @code{%F} and -thus a poor idea to use, if so. -@item %X -The locale's representation of the time. -@item %y -The last two digits in the year. (And at least two digits.) -@item %Y -The year with as many digits as necessary. -@item %z -The offset of the timezone from UTC. Either -@code{+hhmm} or @code{-hhmm} (starts with a hyphen.) -@item %Z -The name of the timezone, abbreviation. -@item %% -A literal `%'. -@end table +@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 Multimedia +@end ifclear -Note, this is not all that @sc{POSIX} specifies, -but it is the basics. @sc{POSIX} does not specify -any support for 6-hour clocks, for Saturday as the -first day of the week (or Tuesay through Friday,) or -Sunday to be represented by 1 or Monday as 0. If you -need any of these, you should look into the -specifications for your @sc{C} standard libraries -implementation of @code{strftime}, which may or may -nor support this. +@dircategory @value{CATEGORY} +@direntry +* scrotty: (scrotty). @value{subtitle} +@end direntry +@documentdescription +User manual for scrotty. +A screenshoter for the framebuffer. +@end documentdescription +@c %**end of header -@node GNU Free Documentation License -@appendix GNU Free Documentation License -@include fdl.texinfo +@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 scrotty + that the manual is up to date with, by setting the value of VERSION + to the version of scrotty, 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 diff --git a/doc/info/titlepage-data.texinfo b/doc/info/titlepage-data.texinfo new file mode 100644 index 0000000..594cc37 --- /dev/null +++ b/doc/info/titlepage-data.texinfo @@ -0,0 +1,24 @@ +@c The title and the subtitle of the manual. +@set title scrotty +@set subtitle Take a screenshot of the framebuffer + +@c The full name of the documented program or package. +@set programname @command{scrotty} +@set programnamewiththe @command{scrotty} + + +@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. +@set HAVE_DEDICATION +@macro dedication{} +@center `I don't know how to make a screenshot, because I normally use my computer in +@center text-mode. I have @sc{X} and @sc{GNOME} installed, but I use them only occasionally.' --- rms +@end macro +@c (I don't use dedications, I use quotes.) + |