diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2011-11-06 01:45:07 +0200 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2011-11-06 01:50:55 +0200 |
commit | 3ec5d07e67044b614b8beab0e34908b4eec23eab (patch) | |
tree | e8bbb96e728b84d94b93f02e9f560c79a13855cf /doc | |
parent | 6d9c7d666f83da5d9f69d7e30b138d1a6e2e69da (diff) | |
download | mailutils-3ec5d07e67044b614b8beab0e34908b4eec23eab.tar.gz mailutils-3ec5d07e67044b614b8beab0e34908b4eec23eab.tar.bz2 |
Update docs + minor changes.
* .gitmodules: Add imprimatur.
* Makefile.am: Likewise.
* configure.ac: Likewise.
* doc/Makefile.am: Likewise.
* bootstrap.conf: Comment out make in doc/texinfo
* doc/texinfo/Makefile.am: Rewrite.
* doc/texinfo/fdl.texi: Minor change.
* doc/texinfo/getdate.texi: Minor change.
* doc/texinfo/mailutils.texi: begin rewrite.
* doc/texinfo/mu-mh.texi: Minor change.
* doc/texinfo/programs.texi: begin rewrite.
* doc/texinfo/sieve.texi: Minor change.
* doc/texinfo/usage.texi: Minor change.
* libmailutils/cfg/lexer.l: Allow for @ in unquoted strings
* pop3d/bulletin.c: Relax safety checks for bulletin.db
* pop3d/logindelay.c: Relax safety checks for stat.sb
* pop3d/pop3d.h (DEFAULT_GROUP_DB_SAFETY): New define.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 2 | ||||
m--------- | doc/imprimatur | 0 | ||||
-rw-r--r-- | doc/texinfo/.gitignore | 4 | ||||
-rw-r--r-- | doc/texinfo/Makefile.am | 181 | ||||
-rw-r--r-- | doc/texinfo/fdl.texi | 85 | ||||
-rw-r--r-- | doc/texinfo/getdate.texi | 134 | ||||
-rw-r--r-- | doc/texinfo/mailutils.texi | 436 | ||||
-rw-r--r-- | doc/texinfo/mu-mh.texi | 74 | ||||
-rw-r--r-- | doc/texinfo/programs.texi | 3751 | ||||
-rw-r--r-- | doc/texinfo/sieve.texi | 270 | ||||
-rw-r--r-- | doc/texinfo/usage.texi | 48 |
11 files changed, 2887 insertions, 2098 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 4be776306..9d4a1724d 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -15,5 +15,5 @@ ## You should have received a copy of the GNU General Public License ## along with GNU Mailutils. If not, see <http://www.gnu.org/licenses/>. -SUBDIRS = texinfo man +SUBDIRS = imprimatur texinfo man EXTRA_DIST = ChangeLog.CVS rfc/README diff --git a/doc/imprimatur b/doc/imprimatur new file mode 160000 +Subproject f32ef1983968e755cd580b06e369476d7e7f88b diff --git a/doc/texinfo/.gitignore b/doc/texinfo/.gitignore index 9e5dd4640..1a044fb19 100644 --- a/doc/texinfo/.gitignore +++ b/doc/texinfo/.gitignore @@ -19,6 +19,10 @@ mailutils.tmp mailutils.toc mailutils.tp mailutils.vr +mailutils.fl +mailutils.kw +mailutils.pdf +mailutils.pr mdate-sh muint.info* stamp-1 diff --git a/doc/texinfo/Makefile.am b/doc/texinfo/Makefile.am index dd28976a1..ec9929974 100644 --- a/doc/texinfo/Makefile.am +++ b/doc/texinfo/Makefile.am @@ -17,174 +17,53 @@ info_TEXINFOS = mailutils.texi -INCFILES = \ - addr.inc\ - http.inc\ - mailcap.inc\ - numaddr.inc\ - sfrom.inc\ - url-parse.inc - -RENDITION_TEXI=rendition.texi macros.texi - mailutils_TEXINFOS = \ - address.texi\ - attribute.texi\ - auth.texi\ - body.texi\ - c-api.texi\ - encoding.texi\ - envelope.texi\ fdl.texi\ - folder.texi\ - framework.texi\ getdate.texi\ - headers.texi\ - imap4.texi\ - iterator.texi\ - libmu_scm.texi\ - libmu_auth.texi\ - libmu_sieve.texi\ - locker.texi\ - mailbox.texi\ - mailcap.texi\ - maildir.texi\ - mailer.texi\ - mbox.texi\ - message.texi\ - mh.texi\ + macros.texi\ mu-mh.texi\ - mu_address.texi\ - mu_body.texi\ - mu_logger.texi\ - mu_mailbox.texi\ - mu_message.texi\ - mu_mime.texi\ - mu_scm.texi\ - nntp.texi\ - parse822.texi\ - pop3.texi\ programs.texi\ - sendmail.texi\ sieve.texi\ - smtp.texi\ - stream.texi\ usage.texi\ - url.texi\ - $(RENDITION_TEXI)\ - $(INCFILES) + version.texi -DISTCLEANFILES=*.pgs *.kys *.vrs clean-local: rm -rf manual -# The rendering level is one of PUBLISH, DISTRIB or PROOF. -# Just call `make RENDITION=PROOF [target]' if you want PROOF rendition. - -MAKEINFOFLAGS=-D$(RENDITION) -GENDOCS=gendocs.sh -TEXI2DVI=texi2dvi -t '@set $(RENDITION)' -E - -# Make sure you set TEXINPUTS. -# TEXINPUTS=/usr/share/texmf/pdftex/plain/misc/ is ok for most distributions - -TEXINPUTS=$(srcdir):$(top_srcdir)/build-aux:$$TEXINPUTS - -manual: - TEXINPUTS=$(srcdir):$(top_srcdir)/build-aux:$(TEXINPUTS) \ - MAKEINFO="$(MAKEINFO) $(MAKEINFOFLAGS)" \ - TEXI2DVI="$(TEXI2DVI) -t @finalout" \ - $(GENDOCS) --texi2html $(PACKAGE) '$(PACKAGE_NAME) manual' +AM_MAKEINFOFLAGS = @IMPRIMATUR_MAKEINFOFLAGS@ +# Imprimatur setup +imprimatur_INPUT=$(info_TEXINFOS) $(mailutils_TEXINFOS) +include ../imprimatur/imprimatur.mk +#CHECK_DOCS=$(top_srcdir)/@IMPRIMATUR_MODULE_DIR@/check-docs.sh - -EXTRA_DIST=gendocs_template mastermenu.el untabify.el +# Checking +all-check-docs: imprimatur-basic-checks -master-menu: - emacs -batch -l mastermenu.el -f make-master-menu $(info_TEXINFOS) +check-docs: + @$(MAKE) -k all-check-docs -untabify: - emacs -batch -l untabify.el $(info_TEXINFOS) $(mailutils_TEXINFOS) +# -fix-sentence-spacing: - for file in $(info_TEXINFOS) $(mailutils_TEXINFOS); \ - do \ - if grep -q '\. [@A-Z]' $$file; then \ - mv $$file $${file}~; \ - sed -r 's/\. ([@A-Z])/. \1/g' $${file}~ > $$file; \ - fi; \ - done +master-menu: imprimatur-master-menu +untabify: imprimatur-untabify +final: imprimatur-final -final: untabify fix-sentence-spacing master-menu +# Web manual +#EXTRA_DIST = \ +# gendocs_template - -# Checks -check-tabs: - @if test -n "`cat $(info_TEXINFOS) $(mailutils_TEXINFOS) |\ - tr -d -c '\t'`"; then \ - echo >&2 "Sources contain tabs; run make untabify"; \ - false; \ - fi - -check-sentence-spacing: - @if grep -q '\. [@A-Z]' $(info_TEXINFOS) $(mailutils_TEXINFOS); then \ - echo >&2 "Sources contain double-space sentence separators"; \ - echo >&2 "Run make fix-sentence-spacing to fix"; \ - fi - -check-format: check-tabs check-sentence-spacing - -check-refs: - @for file in $(info_TEXINFOS) $(mailutils_TEXINFOS); \ - do \ - sed -e = $$file | \ - sed -n 'N;/@FIXME-.*ref/{s/\(^[0-9][0-9]*\).*@FIXME-.*ref{\([^}]*\)}.*/'$$file':\1: \2/gp}'; \ - done > $@-t; \ - if [ -s $@-t ]; then \ - echo >&2 "Unresolved cross-references:"; \ - cat $@-t >&2;\ - rm $@-t; \ - else \ - rm -f $@-t; \ - fi - -check-fixmes: - @for file in $(info_TEXINFOS) $(mailutils_TEXINFOS); \ - do \ - sed -e = $$file | \ - sed -n 'N;/@FIXME{/{s/\(^[0-9][0-9]*\).*@FIXME{\([^}]*\).*/'$$file':\1: \2/gp}'; \ - done > $@-t; \ - if [ -s $@-t ]; then \ - echo >&2 "Unresolved FIXMEs:"; \ - cat $@-t >&2; \ - rm $@-t; \ - false; \ - else \ - rm -f $@-t; \ - fi - -check-writeme: - @grep -Hn @WRITEME $(info_TEXINFOS) $(mailutils_TEXINFOS) > $@-t; \ - if [ -s $@-t ]; then \ - echo "Empty nodes:"; \ - cat $@-t; \ - rm $@-t; \ - false;\ - else \ - rm $@-t; \ - fi +GENDOCS=gendocs.sh +TEXI2DVI=texi2dvi -t '@set $(RENDITION)' -E -check-unrevised: - @grep -Hn @UNREVISED $(info_TEXINFOS) $(mailutils_TEXINFOS) > $@-t; \ - if [ -s $@-t ]; then \ - echo >&2 "Unrevised nodes:"; \ - cat $@-t >&2; \ - rm $@-t; \ - false;\ - else \ - rm $@-t; \ - fi +.PHONY: manual +manual: + TEXINPUTS=$(srcdir):$(top_srcdir)/build-aux:$(TEXINPUTS) \ + MAKEINFO="$(MAKEINFO) $(MAKEINFOFLAGS) $(AM_MAKEINFOFLAGS)" \ + TEXI2DVI="$(TEXI2DVI)" \ + TEXI2HTML="texi2html $(AM_MAKEINFOFLAGS)" \ + $(GENDOCS) --texi2html $(PACKAGE) '$(PACKAGE_NAME) manual' -all-check-docs: check-format check-writeme check-unrevised check-refs check-fixmes +manual.tar.bz2: manual + tar cfj manual.tar.bz2 manual -check-docs: - $(MAKE) -k all-check-docs +man-tar: manual.tar.bz2 diff --git a/doc/texinfo/fdl.texi b/doc/texinfo/fdl.texi index ab401d0aa..31cf84097 100644 --- a/doc/texinfo/fdl.texi +++ b/doc/texinfo/fdl.texi @@ -1,6 +1,3 @@ -@setfilename fdl.info -@node GNU FDL -@appendix GNU Free Documentation License @cindex FDL, GNU Free Documentation License @center Version 1.2, November 2002 @@ -26,16 +23,16 @@ 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 +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; +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 +whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference. @item @@ -43,11 +40,11 @@ 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 +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 +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. @@ -68,15 +65,15 @@ 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 +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 +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 +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, @@ -86,19 +83,19 @@ 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 +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''. +of text. A copy that is not ``Transparent'' is called ``Opaque''. Examples of suitable formats for Transparent copies include plain @sc{ascii} without markup, Texinfo input format, La@TeX{} input format, @acronym{SGML} or @acronym{XML} using a publicly available @acronym{DTD}, and standard-conforming simple @acronym{HTML}, -PostScript or @acronym{PDF} designed for human modification. Examples +PostScript or @acronym{PDF} designed for human modification. Examples of transparent image formats include @acronym{PNG}, @acronym{XCF} and -@acronym{JPG}. Opaque formats include proprietary formats that can be +@acronym{JPG}. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, @acronym{SGML} or @acronym{XML} for which the @acronym{DTD} and/or processing tools are not generally available, and the machine-generated @acronym{HTML}, @@ -107,7 +104,7 @@ 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 +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. @@ -121,7 +118,7 @@ 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 +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 @@ -134,10 +131,10 @@ 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 +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 +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 @@ -151,10 +148,10 @@ 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 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. +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. @@ -189,14 +186,14 @@ 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: +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 +of the Document). You may use the same title as a previous version if the original publisher of that version gives permission. @item @@ -232,7 +229,7 @@ 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 +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 @@ -242,7 +239,7 @@ Version as stated in the previous sentence. 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. +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. @@ -255,11 +252,11 @@ dedications given therein. @item Preserve all the Invariant Sections of the Document, -unaltered in their text and in their titles. Section numbers +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 +Delete any section Entitled ``Endorsements''. Such a section may not be included in the Modified Version. @item @@ -273,7 +270,7 @@ Preserve any Warranty Disclaimers. 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 +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. @@ -285,9 +282,9 @@ 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 +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 +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 @@ -309,7 +306,7 @@ 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 +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. @@ -319,7 +316,7 @@ 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 +and any sections Entitled ``Dedications''. You must delete all sections Entitled ``Endorsements.'' @item @@ -364,11 +361,11 @@ 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 +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 +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. @@ -381,9 +378,9 @@ title. TERMINATION You may not copy, modify, sublicense, or distribute the Document except -as expressly provided for under this License. Any other attempt to +as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will -automatically terminate your rights under this License. However, +automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. @@ -392,9 +389,9 @@ parties remain in full compliance. 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 +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 +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. @@ -402,7 +399,7 @@ 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 +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. @end enumerate diff --git a/doc/texinfo/getdate.texi b/doc/texinfo/getdate.texi index 741d44935..0a816a7d5 100644 --- a/doc/texinfo/getdate.texi +++ b/doc/texinfo/getdate.texi @@ -7,7 +7,7 @@ @c under the terms of the GNU Free Documentation License, Version 1.2 or @c any later version published by the Free Software Foundation; with no @c Invariant Sections, with no Front-Cover Texts, and with no Back-Cover -@c Texts. A copy of the license is included in the ``GNU Free +@c Texts. A copy of the license is included in the ``GNU Free @c Documentation License'' file as part of this distribution. @cindex date input formats @@ -18,30 +18,30 @@ First, a quote: @quotation Our units of temporal measurement, from seconds on up to months, are so complicated, asymmetrical and disjunctive so as to make coherent mental -reckoning in time all but impossible. Indeed, had some tyrannical god +reckoning in time all but impossible. Indeed, had some tyrannical god contrived to enslave our minds to time, to make it all but impossible for us to escape subjection to sodden routines and unpleasant surprises, he could hardly have done better than handing down our present system. It is like a set of trapezoidal building blocks, with no vertical or horizontal surfaces, like a language in which the simplest thought demands ornate constructions, useless particles and lengthy -circumlocutions. Unlike the more successful patterns of language and +circumlocutions. Unlike the more successful patterns of language and science, which enable us to face experience boldly or at least level-headedly, our system of temporal calculation silently and persistently encourages our terror of time. @dots{} It is as though architects had to measure length in feet, width in meters and height in ells; as though basic instruction manuals -demanded a knowledge of five different languages. It is no wonder then +demanded a knowledge of five different languages. It is no wonder then that we often look into our own immediate past or future, last Tuesday -or a week from Sunday, with feelings of helpless confusion. @dots{} +or a week from Sunday, with feelings of helpless confusion. @dots{} --- Robert Grudin, @cite{Time and the Art of Living}. @end quotation This section describes the textual date representations that @sc{gnu} -programs accept. These are the strings you, as a user, can supply as -arguments to the various programs. The C interface (via the +programs accept. These are the strings you, as a user, can supply as +arguments to the various programs. The C interface (via the @code{get_date} function) is not described here. @menu @@ -65,9 +65,9 @@ arguments to the various programs. The C interface (via the @cindex items in date strings A @dfn{date} is a string, possibly empty, containing many items -separated by whitespace. The whitespace may be omitted when no -ambiguity arises. The empty string means the beginning of today (i.e., -midnight). Order of the items is immaterial. A date string may contain +separated by whitespace. The whitespace may be omitted when no +ambiguity arises. The empty string means the beginning of today (i.e., +midnight). Order of the items is immaterial. A date string may contain many flavors of items: @itemize @bullet @@ -86,11 +86,11 @@ many flavors of items: @findex first @r{in date strings} @findex next @r{in date strings} @findex last @r{in date strings} -A few ordinal numbers may be written out in words in some contexts. This is +A few ordinal numbers may be written out in words in some contexts. This is most useful for specifying day of the week items or relative items (see -below). Among the most commonly used ordinal numbers, the word +below). Among the most commonly used ordinal numbers, the word @samp{last} stands for @math{-1}, @samp{this} stands for 0, and -@samp{first} and @samp{next} both stand for 1. Because the word +@samp{first} and @samp{next} both stand for 1. Because the word @samp{second} stands for the unit of time there is no way to write the ordinal number 2, but for convenience @samp{third} stands for 3, @samp{fourth} for 4, @samp{fifth} for 5, @@ -113,10 +113,10 @@ abbreviations like @samp{AM}, @samp{DST}, @samp{EST}, @samp{first}, The output of the @command{date} command is not always acceptable as a date string, not only because of the language problem, but also because there is no -standard meaning for time zone items like @samp{IST}. When using +standard meaning for time zone items like @samp{IST}. When using @command{date} to generate a date string intended to be parsed later, specify a date format that is independent of language and that does not -use time zone items other than @samp{UTC} and @samp{Z}. Here are some +use time zone items other than @samp{UTC} and @samp{Z}. Here are some ways to do this: @example @@ -136,13 +136,13 @@ $ date +'@@%s.%N' # %s and %N are GNU extensions. @cindex case, ignored in dates @cindex comments, in dates -Alphabetic case is completely ignored in dates. Comments may be introduced +Alphabetic case is completely ignored in dates. Comments may be introduced between round parentheses, as long as included parentheses are properly -nested. Hyphens not followed by a digit are currently ignored. Leading +nested. Hyphens not followed by a digit are currently ignored. Leading zeros on numbers are ignored. Invalid dates like @samp{2005-02-29} or times like @samp{24:00} are -rejected. In the typical case of a host that does not support leap +rejected. In the typical case of a host that does not support leap seconds, a time like @samp{23:59:60} is rejected even if it corresponds to a valid leap second. @@ -152,9 +152,9 @@ corresponds to a valid leap second. @cindex calendar date item -A @dfn{calendar date item} specifies a day of the year. It is +A @dfn{calendar date item} specifies a day of the year. It is specified differently, depending on whether the month is specified -numerically or literally. All these strings specify the same calendar date: +numerically or literally. All these strings specify the same calendar date: @example 1972-09-24 # @sc{iso} 8601. @@ -170,8 +170,8 @@ Sep 24, 1972 24sep72 @end example -The year can also be omitted. In this case, the last specified year is -used, or the current year if none. For example: +The year can also be omitted. In this case, the last specified year is +used, or the current year if none. For example: @example 9/24 @@ -185,19 +185,19 @@ Here are the rules. For numeric months, the @sc{iso} 8601 format @samp{@var{year}-@var{month}-@var{day}} is allowed, where @var{year} is any positive number, @var{month} is a number between 01 and 12, and -@var{day} is a number between 01 and 31. A leading zero must be present -if a number is less than ten. If @var{year} is 68 or smaller, then 2000 +@var{day} is a number between 01 and 31. A leading zero must be present +if a number is less than ten. If @var{year} is 68 or smaller, then 2000 is added to it; otherwise, if @var{year} is less than 100, -then 1900 is added to it. The construct +then 1900 is added to it. The construct @samp{@var{month}/@var{day}/@var{year}}, popular in the United States, -is accepted. Also @samp{@var{month}/@var{day}}, omitting the year. +is accepted. Also @samp{@var{month}/@var{day}}, omitting the year. @cindex month names in date strings @cindex abbreviations for months Literal months may be spelled out in full: @samp{January}, @samp{February}, @samp{March}, @samp{April}, @samp{May}, @samp{June}, @samp{July}, @samp{August}, @samp{September}, @samp{October}, -@samp{November} or @samp{December}. Literal months may be abbreviated +@samp{November} or @samp{December}. Literal months may be abbreviated to their first three letters, possibly followed by an abbreviating dot. It is also permitted to write @samp{Sept} instead of @samp{September}. @@ -224,13 +224,13 @@ Or, omitting the year: @cindex time of day item A @dfn{time of day item} in date strings specifies the time on a given -day. Here are some examples, all of which represent the same time: +day. Here are some examples, all of which represent the same time: @example 20:02:00.000000 20:02 8:02pm -20:02-0500 # In @sc{est} (U.S. Eastern Standard Time). +20:02-0500 # In @sc{est} (U.S. Eastern Standard Time). @end example More generally, the time of day may be given as @@ -240,7 +240,7 @@ a number between 0 and 23, @var{minute} is a number between 0 and @samp{.} or @samp{,} and a fraction containing one or more digits. Alternatively, @samp{:@var{second}} can be omitted, in which case it is taken to -be zero. On the rare hosts that support leap seconds, @var{second} +be zero. On the rare hosts that support leap seconds, @var{second} may be 60. @findex am @r{in date strings} @@ -249,9 +249,9 @@ may be 60. @findex noon @r{in date strings} If the time is followed by @samp{am} or @samp{pm} (or @samp{a.m.} or @samp{p.m.}), @var{hour} is restricted to run from 1 to 12, and -@samp{:@var{minute}} may be omitted (taken to be zero). @samp{am} +@samp{:@var{minute}} may be omitted (taken to be zero). @samp{am} indicates the first half of the day, @samp{pm} indicates the second -half of the day. In this notation, 12 is the predecessor of 1: +half of the day. In this notation, 12 is the predecessor of 1: midnight is @samp{12am} while noon is @samp{12pm}. (This is the zero-oriented interpretation of @samp{12am} and @samp{12pm}, as opposed to the old tradition derived from Latin @@ -269,7 +269,7 @@ You can also separate @var{hh} from @var{mm} with a colon. When a time zone correction is given this way, it forces interpretation of the time relative to Coordinated Universal Time (@sc{utc}), overriding any previous -specification for the time zone or the local time zone. For example, +specification for the time zone or the local time zone. For example, @samp{+0530} and @samp{+05:30} both stand for the time zone 5.5 hours ahead of @sc{utc} (e.g., India). This is the best way to @@ -288,19 +288,19 @@ but not both. A @dfn{time zone item} specifies an international time zone, indicated by a small set of letters, e.g., @samp{UTC} or @samp{Z} for Coordinated Universal -Time. Any included periods are ignored. By following a +Time. Any included periods are ignored. By following a non-daylight-saving time zone by the string @samp{DST} in a separate word (that is, separated by some white space), the corresponding daylight saving time zone may be specified. Alternatively, a non-daylight-saving time zone can be followed by a -time zone correction, to add the two values. This is normally done +time zone correction, to add the two values. This is normally done only for @samp{UTC}; for example, @samp{UTC+05:30} is equivalent to @samp{+05:30}. Time zone items other than @samp{UTC} and @samp{Z} are obsolescent and are not recommended, because they are ambiguous; for example, @samp{EST} has a different meaning in -Australia than in the United States. Instead, it's better to use +Australia than in the United States. Instead, it's better to use unambiguous numeric time zone corrections like @samp{-0500}, as described in the previous section. @@ -319,8 +319,8 @@ The explicit mention of a day of the week will forward the date Days of the week may be spelled out in full: @samp{Sunday}, @samp{Monday}, @samp{Tuesday}, @samp{Wednesday}, @samp{Thursday}, -@samp{Friday} or @samp{Saturday}. Days may be abbreviated to their -first three letters, optionally followed by a period. The special +@samp{Friday} or @samp{Saturday}. Days may be abbreviated to their +first three letters, optionally followed by a period. The special abbreviations @samp{Tues} for @samp{Tuesday}, @samp{Wednes} for @samp{Wednesday} and @samp{Thur} or @samp{Thurs} for @samp{Thursday} are also allowed. @@ -328,8 +328,8 @@ also allowed. @findex next @var{day} @findex last @var{day} A number may precede a day of the week item to move forward -supplementary weeks. It is best used in expression like @samp{third -monday}. In this context, @samp{last @var{day}} or @samp{next +supplementary weeks. It is best used in expression like @samp{third +monday}. In this context, @samp{last @var{day}} or @samp{next @var{day}} is also acceptable; they move one week before or after the day that @var{day} by itself would represent. @@ -343,7 +343,7 @@ A comma following a day of the week item is ignored. @cindex displacement of dates @dfn{Relative items} adjust a date (or the current date if none) forward -or backward. The effects of relative items accumulate. Here are some +or backward. The effects of relative items accumulate. Here are some examples: @example @@ -361,18 +361,18 @@ examples: @findex hour @r{in date strings} @findex minute @r{in date strings} The unit of time displacement may be selected by the string @samp{year} -or @samp{month} for moving by whole years or months. These are fuzzy -units, as years and months are not all of equal duration. More precise +or @samp{month} for moving by whole years or months. These are fuzzy +units, as years and months are not all of equal duration. More precise units are @samp{fortnight} which is worth 14 days, @samp{week} worth 7 days, @samp{day} worth 24 hours, @samp{hour} worth 60 minutes, @samp{minute} or @samp{min} worth 60 seconds, and @samp{second} or -@samp{sec} worth one second. An @samp{s} suffix on these units is +@samp{sec} worth one second. An @samp{s} suffix on these units is accepted and ignored. @findex ago @r{in date strings} The unit of time may be pre |