diff options
author | Karl Berry <karl@freefriends.org> | 2009-01-02 08:11:07 -0800 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2009-01-02 08:11:07 -0800 |
commit | e87d931500c732d57c5040f4a4a147d6875267fa (patch) | |
tree | bb7780fd780fe60ab6f74c875e6c58303874c591 /doc | |
parent | 50ad42330bc3635768964dc2626ffe0823992016 (diff) | |
download | gnulib-e87d931500c732d57c5040f4a4a147d6875267fa.tar.gz |
autoupdate (for gendocs.sh accepting --email)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/gendocs_template | 12 | ||||
-rw-r--r-- | doc/gendocs_template_min | 13 | ||||
-rw-r--r-- | doc/maintain.texi | 65 |
3 files changed, 47 insertions, 43 deletions
diff --git a/doc/gendocs_template b/doc/gendocs_template index abf3b1fdf3..94cecef453 100644 --- a/doc/gendocs_template +++ b/doc/gendocs_template @@ -83,16 +83,14 @@ There are also <a href="/contact/">other ways to contact</a> the FSF. <br /> Please send broken links and other corrections or suggestions to -<a href="mailto:webmasters@gnu.org"><em>webmasters@gnu.org</em></a>. +<a href="mailto:%%EMAIL%%"><em>%%EMAIL%%</em></a>. </p> -<p> -Copyright © 2008 Free Software Foundation, Inc., -</p> -<address>51 Franklin Street, Fifth Floor, Boston, MA 02111, USA</address> +<p>Copyright © 2009 Free Software Foundation, Inc.</p> + <p>Verbatim copying and distribution of this entire article is -permitted in any medium, provided this notice is preserved. -</p> +permitted in any medium, provided this notice is preserved.</p> + </div> </div> diff --git a/doc/gendocs_template_min b/doc/gendocs_template_min index 8037f9c72b..ce1bbe369f 100644 --- a/doc/gendocs_template_min +++ b/doc/gendocs_template_min @@ -92,16 +92,13 @@ There are also <a href="/home.html#ContactInfo">other ways to contact</a> the FSF. <br /> Please send broken links and other corrections (or suggestions) to -<a href="mailto:webmasters@gnu.org"><em>webmasters@gnu.org</em></a>. +<a href="mailto:%%EMAIL%%"><em>%%EMAIL%%</em></a>. </p> -<p> -Copyright © 2007 Free Software Foundation, Inc., -51 Franklin Street, Fifth Floor, Boston, MA 02111, USA -<br /> -Verbatim copying and distribution of this entire article is -permitted in any medium, provided this notice is preserved. -</p> +<p>Copyright © 2009 Free Software Foundation, Inc.</p> + +<p>Verbatim copying and distribution of this entire article is +permitted in any medium, provided this notice is preserved.</p> </div> diff --git a/doc/maintain.texi b/doc/maintain.texi index 7b1c4c0ec0..1e58917515 100644 --- a/doc/maintain.texi +++ b/doc/maintain.texi @@ -5,7 +5,7 @@ @c For double-sided printing, uncomment: @c @setchapternewpage odd @c This date is automagically updated when you save this file: -@set lastupdate November 14, 2008 +@set lastupdate January 1, 2009 @c %**end of header @dircategory GNU organization @@ -25,7 +25,7 @@ Information for maintainers of GNU software, last updated @value{lastupdate}. Copyright @copyright{} 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, -2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software +2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. @quotation @@ -734,17 +734,18 @@ name. Please adjust the list of invariant sections as appropriate for your manual. If there are none, then say ``with no Invariant Sections''. If your manual is not published by the FSF, and under 400 pages, you -can omit both cover texts and the inclusion of the GPL. +can omit both cover texts. @xref{GNU Sample Texts,,,texinfo,Texinfo}, for a full example in a Texinfo manual, and see @url{http://www.gnu.org/licenses/fdl-howto.html} for more advice about how to use the GNU FDL. -If the manual is over 400 pages, or if the FSF thinks it might be a good -choice for publishing on paper, then please include our standard -invariant section which explains the importance of free documentation. -Write to @email{assign@@gnu.org} to get a copy of this section. +If the manual is over 400 pages, or if the FSF thinks it might be a +good choice for publishing on paper, then please include the GNU GPL, +as in the notice above. Please also include our standard invariant +section which explains the importance of free documentation. Write to +@email{assign@@gnu.org} to get a copy of this section. When you distribute several manuals together in one software package, their on-line forms can share a single copy of the GFDL (see @@ -1582,32 +1583,36 @@ Texinfo documentation output for your web pages section above. It has a companion template file, used as the basis for the HTML index pages. Both are available from the Texinfo CVS sources: -@format + +@smallformat @uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs.sh} @uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template} -@end format +@end smallformat -There is also a ``minimalistic'' template version, available from: +There is also a minimalistic template, available from: -@format +@smallformat @uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template_min} -@end format +@end smallformat Invoke the script like this, in the directory containing the Texinfo source: -@example -gendocs.sh @var{yourmanual} "GNU @var{yourmanual} manual" -@end example -@noindent where @var{yourmanual} is the short name for your package. -The script processes the file @file{@var{yourmanual}.texinfo} (or -@file{.texi} or @file{.txi}). For example: +@smallexample +gendocs.sh --email @var{yourbuglist} @var{yourmanual} "GNU @var{yourmanual} manual" +@end smallexample + +@noindent where @var{yourmanual} is the short name for your package +and @var{yourbuglist} is the email address for bug reports (typically +@code{bug-@var{package}@@gnu.org}). The script processes the file +@file{@var{yourmanual}.texinfo} (or @file{.texi} or @file{.txi}). For +example: -@example +@smallexample cd .../emacs/man # download gendocs.sh and gendocs_template -gendocs.sh emacs "GNU Emacs manual" -@end example +gendocs.sh --email bug-gnu-emacs@@gnu.org emacs "GNU Emacs manual" +@end smallexample @command{gendocs.sh} creates a subdirectory @file{manual/} containing the manual generated in all the standard output formats: Info, HTML, @@ -1630,20 +1635,21 @@ times with different arguments, specifying a different output directory with @option{-o} each time, and moving all the output to your web page. Then write (by hand) an overall index.html with links to them all. For example: -@example + +@smallexample cd .../texinfo/doc -gendocs.sh -o texinfo texinfo "GNU Texinfo manual" -gendocs.sh -o info info "GNU Info manual" -gendocs.sh -o info-stnd info-stnd "GNU info-stnd manual" -@end example +gendocs.sh --email bug-texinfo@@gnu.org -o texinfo texinfo "GNU Texinfo manual" +gendocs.sh --email bug-texinfo@@gnu.org -o info info "GNU Info manual" +gendocs.sh --email bug-texinfo@@gnu.org -o info-stnd info-stnd "GNU info-stnd manual" +@end smallexample By default, the script uses @command{makeinfo} for generating @acronym{HTML} output. If you prefer to use @command{texi2html}, use the @option{--texi2html} command line option, e.g.: -@example +@smallexample gendocs --texi2html -o texinfo texinfo "GNU Texinfo manual" -@end example +@end smallexample The template files will automatically produce entries for additional HTML output generated by @command{texi2html} (i.e., split by sections @@ -1654,6 +1660,9 @@ You can set the environment variables @env{MAKEINFO}, @env{TEXI2DVI}, executed, and @env{GENDOCS_TEMPLATE_DIR} to control where the @file{gendocs_template} file is found. +As usual, run @samp{gendocs.sh --help} for a description of all the +options, environment variables, and more information. + Please email bug reports, enhancement requests, or other correspondence to @email{bug-texinfo@@gnu.org}. |