diff options
| -rw-r--r-- | .gitignore | 14 | ||||
| -rw-r--r-- | LICENSE | 31 | ||||
| -rw-r--r-- | Makefile | 160 | ||||
| -rw-r--r-- | README | 1 | ||||
| -rw-r--r-- | TODO | 12 | ||||
| -rw-r--r-- | config.mk | 8 | ||||
| -rw-r--r-- | doc/info/fdl.texinfo | 505 | ||||
| -rw-r--r-- | doc/info/rq.texinfo | 143 | ||||
| -rw-r--r-- | rq.1 (renamed from doc/man/rq.1) | 55 | ||||
| -rw-r--r-- | rq.c (renamed from src/rq.c) | 197 |
10 files changed, 175 insertions, 951 deletions
@@ -1,16 +1,6 @@ -_/ -/bin/ -/obj/ -\#*\# +*\#* .* -!.git* *~ -*.bak -*.new -*.swo -*.swp -*.out *.o *.su -*.gch - +/rq @@ -1,22 +1,15 @@ -MIT/X Consortium License +ISC License -Copyright © 2015 Mattias Andrée <maandree@member.fsf.org> +© 2015, 2021 Mattias Andrée <maandree@kth.se> -Permission is hereby granted, free of charge, to any person obtaining a -copy of this software and associated documentation files (the "Software"), -to deal in the Software without restriction, including without limitation -the rights to use, copy, modify, merge, publish, distribute, sublicense, -and/or sell copies of the Software, and to permit persons to whom the -Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -DEALINGS IN THE SOFTWARE. +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. @@ -1,150 +1,30 @@ -# Copying and distribution of this file, with or without modification, -# are permitted in any medium without royalty provided the copyright -# notice and this notice are preserved. This file is offered as-is, -# without any warranty. +.PHONY: -PREFIX = /usr -BIN = /bin -DATA = /share -BINDIR = $(PREFIX)$(BIN) -DATADIR = $(PREFIX)$(DATA) -DOCDIR = $(DATADIR)/doc -INFODIR = $(DATADIR)/info -MANDIR = $(DATADIR)/man -MAN1DIR = $(MANDIR)/man1 -LICENSEDIR = $(DATADIR)/licenses +CONFIGFILE = config.mk +include $(CONFIGFILE) -PKGNAME = rq -COMMAND = rq +all: rq -OPTIMISE = -O2 -WARN = -Wall -Wextra -pedantic -FLAGS = -std=c99 $(WARN) $(OPTIMISE) +rq: rq.o + $(CC) -o $@ $@.o $(LDFLAGS) +.c.o: + $(CC) -c -o $@ $< $(CFLAGS) $(CPPFLAGS) +install: rq + mkdir -p -- "$(DESTDIR)$(PREFIX)/bin" + mkdir -p -- "$(DESTDIR)$(MANPREFIX)/man1" + cp -- rq "$(DESTDIR)$(PREFIX)/bin/$(COMMAND)" + cp -- rq.1 "$(DESTDIR)$(MANPREFIX)/man1/$(COMMAND).1" -.PHONY: default -default: base info - -.PHONY: all -all: base doc - -.PHONY: bas -base: cmd - -.PHONY: command -cmd: bin/rq - -bin/rq: obj/rq.o - @mkdir -p bin - ${CC} ${FLAGS} -o $@ $^ ${LDFLAGS} - -obj/%.o: src/%.c - mkdir -p obj - ${CC} ${FLAGS} -c -o $@ ${CPPFLAGS} ${CFLAGS} $< - -.PHONY: doc -doc: info pdf dvi ps - -.PHONY: info -info: bin/rq.info -bin/%.info: doc/info/%.texinfo - @mkdir -p bin - $(MAKEINFO) $< - mv $*.info $@ - -.PHONY: pdf -pdf: bin/rq.pdf -bin/%.pdf: doc/info/%.texinfo - @! test -d obj/pdf || rm -rf obj/pdf - @mkdir -p bin obj/pdf - cd obj/pdf && texi2pdf ../../"$<" < /dev/null - mv obj/pdf/$*.pdf $@ - -.PHONY: dvi -dvi: bin/rq.dvi -bin/%.dvi: doc/info/%.texinfo - @! test -d obj/dvi || rm -rf obj/dvi - @mkdir -p bin obj/dvi - cd obj/dvi && $(TEXI2DVI) ../../"$<" < /dev/null - mv obj/dvi/$*.dvi $@ - -.PHONY: ps -ps: bin/rq.ps -bin/%.ps: doc/info/%.texinfo - @! test -d obj/ps || rm -rf obj/ps - @mkdir -p bin obj/ps - cd obj/ps && texi2pdf --ps ../../"$<" < /dev/null - mv obj/ps/$*.ps $@ - - - -.PHONY: install -install: install-base install-info install-man - -.PHONY: install-all -install-all: install-base install-doc - -.PHONY: install-base -install-base: install-cmd install-copyright - -.PHONY: install-cmd -install-cmd: bin/rq - install -dm755 -- "$(DESTDIR)$(BINDIR)" - install -m755 $< -- "$(DESTDIR)$(BINDIR)/$(COMMAND)" - -.PHONY: install-copyright -install-copyright: install-license - -.PHONY: install-license -install-license: - install -dm755 -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - install -m644 LICENSE -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - -.PHONY: install-doc -install-doc: install-info install-pdf install-dvi install-ps install-man - -.PHONY: install-info -install-info: bin/rq.info - install -dm755 -- "$(DESTDIR)$(INFODIR)" - install -m644 $< -- "$(DESTDIR)$(INFODIR)/$(PKGNAME).info" - -.PHONY: install-pdf -install-pdf: bin/rq.pdf - install -dm755 -- "$(DESTDIR)$(DOCDIR)" - install -m644 -- "$<" "$(DESTDIR)$(DOCDIR)/$(PKGNAME).pdf" - -.PHONY: install-dvi -install-dvi: bin/rq.dvi - install -dm755 -- "$(DESTDIR)$(DOCDIR)" - install -m644 -- "$<" "$(DESTDIR)$(DOCDIR)/$(PKGNAME).dvi" - -.PHONY: install-ps -install-ps: bin/rq.ps - install -dm755 -- "$(DESTDIR)$(DOCDIR)" - install -m644 -- "$<" "$(DESTDIR)$(DOCDIR)/$(PKGNAME).ps" - -.PHONY: install-man -install-man: doc/man/rq.1 - install -dm755 -- "$(DESTDIR)$(MAN1DIR)" - install -m644 "$<" -- "$(DESTDIR)$(MAN1DIR)/$(COMMAND).1" - - - -.PHONY: uninstall uninstall: - -rm -- "$(DESTDIR)$(BINDIR)/$(COMMAND)" - -rm -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)/LICENSE" - -rmdir -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - -rm -- "$(DESTDIR)$(INFODIR)/$(PKGNAME).info" - -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).pdf" - -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).dvi" - -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).ps" - -rm -- "$(DESTDIR)$(MAN1DIR)/$(COMMAND).1" + -rm -f -- "$(DESTDIR)$(PREFIX)/$(COMMAND)" + -rm -f -- "$(DESTDIR)$(MANPREFIX)/man1/$(COMMAND).1" - - -.PHONY: clean clean: - -rm -r bin obj + -rm -rf -- rq *.o + +.SUFFIXES: +.SUFFIXES: .o .c +.PHONY: all install uninstall clean @@ -65,4 +65,3 @@ SEE ALSO No similar or otherwise related work known. Please inform me if you know any. There probably is a bunch. - @@ -1,7 +1,5 @@ -The text shall not be centred. Rather, the position -that is to be centred is the position where it reader -is most likely to recognised the word quickest when -focusing there. This point should be highlighted. -Determining this position requires a dictionary to -be processed. - +The text shall not be centred. Rather, the position that is +to be centred is the position where it reader is most likely +to recognised the word quickest when focusing there. This +point should be highlighted. Determining this position +requires a dictionary to be processed. diff --git a/config.mk b/config.mk new file mode 100644 index 0000000..7997417 --- /dev/null +++ b/config.mk @@ -0,0 +1,8 @@ +PREFIX = /usr +MANPREFIX = $(PREFIX)/share/man + +CPPFLAGS = -D_DEFAULT_SOURCE -D_BSD_SOURCE -D_XOPEN_SOURCE=700 +CFLAGS = -std=c99 -O2 -Wall -pedantic +LDFLAGS = -s + +COMMAND = rq diff --git a/doc/info/fdl.texinfo b/doc/info/fdl.texinfo deleted file mode 100644 index cb71f05..0000000 --- a/doc/info/fdl.texinfo +++ /dev/null @@ -1,505 +0,0 @@ -@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/rq.texinfo b/doc/info/rq.texinfo deleted file mode 100644 index de34eed..0000000 --- a/doc/info/rq.texinfo +++ /dev/null @@ -1,143 +0,0 @@ -\input texinfo @c -*-texinfo-*- - -@c %**start of header -@setfilename rq.info -@settitle rq -@afourpaper -@documentencoding UTF-8 -@documentlanguage en -@finalout -@c %**end of header - - -@dircategory Pagers -@direntry -* rq: (rq). Read quickly -@end direntry - - -@copying -Copyright @copyright{} 2015 Mattias Andrée - -@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''. -@end quotation -@end copying - -@ifnottex -@node Top -@top rq -- Read quickly -@insertcopying -@end ifnottex - -@titlepage -@title rq -@subtitle Read quickly -@author by Mattias Andrée (maandree) - -@page -@vskip 0pt plus 1filll -@insertcopying -@page -@end titlepage - -@contents - - - -@menu -* Overview:: Brief overview of @command{rq}. -* Invoking:: Invocation of @command{rq}. -* Commands:: Interacting with @command{rq}. -* GNU Free Documentation License:: Copying and sharing this manual. -@end menu - - - -@node Overview -@chapter Overview - -@command{rq} displays a plain-text word-by-word in the middle -of the terminal. Words are automatically paged in a -specifiable rate, by default 2 words per second. -This is a bit slow, you should turn it up when -gradually until your performance has been optimised. -Repeated words will be indicated by alternating reverse -video highlighting. - -Escape sequences are printed as-is. - -@command{rq} uses a method called rapid serial visual -presentation. - - - -@node Invoking -@chapter Invoking - -@command{rq} optionally takes the name of the file to -display. If the file has been specified, or if @code{-} -is specified, stdin will be display. - -@command{rq} does not recognise any options. - -The word rate is configured via the environment -variable @env{RQ_RATE}. It should be a positive -integer optionally followed by a unit. If no unit -is specified, words per minute will be used. -Valid units are (case-insensitive): - -@table @code -@item wpm -@itemx w/m -@itemx /m -@itemx wpmin -@itemx w/min -@itemx /min -Words per minute. -@item wpsec -@itemx w/sec -@itemx /sec -@itemx wps -@itemx w/s -@itemx /s -@itemx Hz -Words per second. -@end table - - - -@node Commands -@chapter Commands - -@command{rq} responds to the following keys: -@table @kbd -@item + -Increase word rate. -@item - -Decrease word rate. -@item p -Toggle pause. -@item right -@itemx down -Go to the previous word. -@item left -@itemx up -Go to next previous word. -@item q -Exit. -@end table - - - -@node GNU Free Documentation License -@appendix GNU Free Documentation License -@include fdl.texinfo - -@bye - @@ -3,7 +3,7 @@ rq \- read quickly .SH SYNOPSIS .B rq -.RI [ FILE ] +.RI [ file ] .SH DESCRIPTION Displays a plain-text file word-by-word in the middle of the terminal. Words are automatically paged in a @@ -33,22 +33,37 @@ This should a positive integer, optionally followed by a unit. If no unit is specified, words per minute will be used. Valid units are (case-insensitive): -.nf -.PP -.B \ \ \ \ \ \ \ wpm -.B \ \ \ \ \ \ \ w/m -.B \ \ \ \ \ \ \ m -.B \ \ \ \ \ \ \ wpmin -.B \ \ \ \ \ \ \ w/min -.BR \ \ \ \ \ \ \ /min\ \ \ \ Words\ per\ minute. +.RS 14 +.TP +.B wpm +.TQ +.B w/m +.TQ +.B m +.TQ +.B wpmin +.TQ +.B w/min +.TQ +.B /min +Words per minute. .PP -.B \ \ \ \ \ \ \ wpsec -.B \ \ \ \ \ \ \ w/sec -.B \ \ \ \ \ \ \ /sec -.B \ \ \ \ \ \ \ wps -.B \ \ \ \ \ \ \ w/s -.B \ \ \ \ \ \ \ /s -.BR \ \ \ \ \ \ \ Hz\ \ \ \ \ \ Words\ per\ second. +.TP +.B wpsec +.TQ +.B w/sec +.TQ +.B sec +.TQ +.B wps +.TQ +.B w/s +.TQ +.B /s +.TQ +.B Hz +Words per second. +.Re .fi .SH COMMANDS .TP @@ -75,11 +90,3 @@ This should be obvious. No similar or otherwise related work known. Please inform me if you know any. There probably is a bunch. -.SH AUTHORS -Principal author, Mattias Andrée. See the LICENSE file for the full -list of authors. -.SH LICENSE -MIT/X Consortium License. -.SH BUGS -Please report bugs to https://github.com/maandree/rq/issues or to -maandree@member.fsf.org @@ -1,41 +1,17 @@ -/** - * MIT/X Consortium License - * - * Copyright © 2015 Mattias Andrée <maandree@member.fsf.org> - * - * Permission is hereby granted, free of charge, to any person obtaining a - * copy of this software and associated documentation files (the "Software"), - * to deal in the Software without restriction, including without limitation - * the rights to use, copy, modify, merge, publish, distribute, sublicense, - * and/or sell copies of the Software, and to permit persons to whom the - * Software is furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL - * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING - * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER - * DEALINGS IN THE SOFTWARE. - */ +/* See LICENSE file for copyright and license details. */ +#include <sys/ioctl.h> +#include <sys/stat.h> +#include <sys/time.h> +#include <ctype.h> +#include <errno.h> +#include <fcntl.h> +#include <signal.h> #include <stdio.h> #include <stdlib.h> -#include <ctype.h> #include <string.h> #include <strings.h> -#include <errno.h> -#include <unistd.h> -#include <fcntl.h> #include <termios.h> -#include <signal.h> -#include <sys/ioctl.h> -#include <sys/stat.h> -#include <sys/time.h> - -#define t(...) do { if (__VA_ARGS__) goto fail; } while (0) +#include <unistd.h> @@ -112,10 +88,11 @@ static struct word *words; * Signal handler for SIGWINCH. * Invoked when the terminal resizes. */ -static void sigwinch(int signo) +static void +sigwinch(int signo) { - signal(signo, sigwinch); caught_sigwinch = 1; + (void) signo; } @@ -123,17 +100,19 @@ static void sigwinch(int signo) * Signal handler for SIGALRM. * Invoked when the timer expires. */ -static void sigalrm(int signo) +static void +sigalrm(int signo) { - signal(signo, sigalrm); caught_sigalrm = 1; + (void) signo; } /** * Get the size of the terminal. */ -static void get_terminal_size(void) +static void +get_terminal_size(void) { struct winsize winsize; @@ -157,10 +136,10 @@ static void get_terminal_size(void) * * @return The rate in words per minute. */ -static long get_word_rate(void) +static long +get_word_rate(void) { - char *s; - char *e; + char *s, *e; long r; errno = 0; @@ -206,7 +185,8 @@ static long get_word_rate(void) * @param s The string. * @return The number of characters in `s`. */ -static size_t display_len(const char *s) +static size_t +display_len(const char *s) { size_t r = 0; for (; *s; s++) @@ -221,7 +201,8 @@ static size_t display_len(const char *s) * @param fd The file descriptor to the file, -1 to clean up instead. * @return 0 on success, -1 on error. */ -static int load_file(int fd) +static int +load_file(int fd) { static char *buffer = NULL; size_t ptr = 0; @@ -241,12 +222,14 @@ static int load_file(int fd) if (ptr == size) { size = size ? (size << 1) : (8 << 10); new = realloc(buffer, size); - t (new == NULL); + if (!new) + goto fail; buffer = new; } n = read(fd, buffer + ptr, size - ptr); if (n < 0) { - t (errno != EINTR); + if (errno != EINTR) + goto fail; continue; } else if (n == 0) { break; @@ -257,7 +240,8 @@ static int load_file(int fd) return 0; if (ptr == size) { new = realloc(buffer, size += 2); - t (new == NULL); + if (!new) + goto fail; buffer = new; } buffer[ptr++] = '\0'; @@ -269,7 +253,8 @@ static int load_file(int fd) if (word_count == size) { size = size ? (size << 1) : 512; new = realloc(words, size * sizeof(*words)); - t (new == NULL); + if (!new) + goto fail; words = new; } while (isspace(*s)) @@ -289,6 +274,7 @@ static int load_file(int fd) words[i].reverse_video = words[i - 1].reverse_video ^ 1; return 0; + fail: saved_errno = errno; free(buffer), buffer = NULL; @@ -304,7 +290,8 @@ fail: * @param rate The number of words per minute to display. * @return 0 on success, -1 on error. */ -static int display_file(int ttyfd, long rate) +static int +display_file(int ttyfd, long rate) { #define SET_RATE \ (interval.it_value.tv_usec = 60000000L / rate, \ @@ -316,15 +303,18 @@ static int display_file(int ttyfd, long rate) char c; size_t i; struct itimerval interval; + memset(&interval, 0, sizeof(interval)); SET_RATE; for (i = 0; i < word_count; i++) { - t (setitimer(ITIMER_REAL, &interval, NULL)); + if (setitimer(ITIMER_REAL, &interval, NULL)) + goto fail; rewait: n = read(ttyfd, &c, sizeof(c)); if (n < 0) { - t (errno != EINTR); + if (errno != EINTR) + goto fail; c = 0; } else if (n == 0) { break; @@ -332,8 +322,8 @@ static int display_file(int ttyfd, long rate) switch (c) { case '+': /* plus */ case '-': /* hyphen */ - rate += (c == '+' ? RATE_DELTA : -RATE_DELTA); - rate = (rate <= 0 ? 1 : rate); + rate += c == '+' ? RATE_DELTA : -RATE_DELTA; + rate = rate <= 0 ? 1 : rate; SET_RATE; goto rewait; case 'p': /* P */ @@ -341,7 +331,8 @@ static int display_file(int ttyfd, long rate) memset(&interval, 0, sizeof(interval)); else SET_RATE; - t (setitimer(ITIMER_REAL, &interval, NULL)); + if (setitimer(ITIMER_REAL, &interval, NULL)) + goto fail; timer_set ^= 1; goto rewait; case 'q': /* Q */ @@ -351,7 +342,7 @@ static int display_file(int ttyfd, long rate) break; case 'A': /* up */ case 'D': /* left */ - i = (i < 2 ? 0 : (i - 2)); + i = i < 2 ? 0 : i - 2; break; case 0: if (!caught_sigalrm) @@ -363,16 +354,19 @@ static int display_file(int ttyfd, long rate) } get_terminal_size(); - t (fprintf(stdout, "\033[H\033[2J\033[%zu;%zuH%s%s%s", - (height + 1) / 2, - (width - display_len(words[i].word)) / 2 + 1, - words[i].reverse_video ? "\033[7m" : "", - words[i].word, - words[i].reverse_video ? "\033[27m" : "") < 0); - t (fflush(stdout)); + if (fprintf(stdout, "\033[H\033[2J\033[%zu;%zuH%s%s%s", + (height + 1) / 2, + (width - display_len(words[i].word)) / 2 + 1, + words[i].reverse_video ? "\033[7m" : "", + words[i].word, + words[i].reverse_video ? "\033[27m" : "") < 0) + goto fail; + if (fflush(stdout)) + goto fail; } - t (setitimer(ITIMER_REAL, &interval, NULL)); + if (setitimer(ITIMER_REAL, &interval, NULL)) + goto fail; (void) read(ttyfd, &c, sizeof(c)); done: @@ -383,73 +377,77 @@ fail: } -int main(int argc, char *argv[]) +int +main(int argc, char *argv[]) { - int dashed = 0; long rate = get_word_rate(); char *file = NULL; - char *arg; int fd = -1, ttyfd = -1, tty_configured = 0; - struct termios stty; - struct termios saved_stty; + struct termios stty, saved_stty; struct stat _attr; - - /* Check that we have a stdout. */ - if (fstat(STDOUT_FILENO, &_attr)) - t (errno == EBADF); + struct sigaction sa; /* Parse arguments. */ argv0 = argv ? (argc--, *argv++) : "rq"; - while (argc) { - if (!dashed && !strcmp(*argv, "--")) { - dashed = 1; - argv++; - argc--; - } else if (!dashed && **argv == '-') { - arg = *argv++; - argc--; - for (arg++; *arg; arg++) { - goto usage; - } - } else { - if (file) - goto usage; - file = *argv++; + if (argc && argv[0][0] == '-') { + if (argv[0][1] == '-' && !argv[0][2]) { argc--; + argv++; + } else if (argv[0][1]) { + goto usage; } } + if (argc > 1) + goto usage; + + /* Check that we have a stdout. */ + if (fstat(STDOUT_FILENO, &_attr)) + if (errno == EBADF) + goto fail; /* Open file. */ if (!file || !strcmp(file, "-")) { fd = STDIN_FILENO; } else { fd = open(file, O_RDONLY); - t (fd == -1); + if (fd < 0) + goto fail; } /* Load file. */ - t (load_file(fd)); + if (load_file(fd)) + goto fail; /* We do not need the file anymore. */ - close(fd), fd = -1; + close(fd); + fd = -1; /* Get a readable file descriptor for the controlling terminal. */ ttyfd = open("/dev/tty", O_RDONLY); - t (ttyfd == -1); + if (ttyfd < 0) + goto fail; /* Configure terminal. */ - t (fprintf(stdout, "\033[?1049h\033[?25l") < 0); - t (fflush(stdout)); - t (tcgetattr(ttyfd, &stty)); + if (fprintf(stdout, "\033[?1049h\033[?25l") < 0) + goto fail; + if (fflush(stdout)) + goto fail; + if (tcgetattr(ttyfd, &stty)) + goto fail; saved_stty = stty; stty.c_lflag &= (tcflag_t)~(ICANON | ECHO | ISIG); - t (tcsetattr(ttyfd, TCSAFLUSH, &stty)); + if (tcsetattr(ttyfd, TCSAFLUSH, &stty)) + goto fail; tty_configured = 1; /* Display file. */ - signal(SIGALRM, sigalrm); - signal(SIGWINCH, sigwinch); - t (display_file(ttyfd, rate)); + memset(&sa, 0, sizeof(sa)); + sa.sa_handler = sigalrm; + sigaction(SIGALRM, &sa, NULL); + sa.sa_handler = sigwinch; + sigaction(SIGWINCH, &sa, NULL); + if (display_file(ttyfd, rate)) + goto fail; /* Restore terminal configurations. */ tcsetattr(ttyfd, TCSAFLUSH, &saved_stty); @@ -478,7 +476,6 @@ fail: return 1; usage: - fprintf(stderr, "%s: Invalid arguments, see `man 1 rq'.\n", argv0); - return 2; + fprintf(stderr, "usage: %s [file].\n", argv0); + return 1; } - |