From ff6115227a1ced14e2fb3d160a12181b9dfbc502 Mon Sep 17 00:00:00 2001 From: Werner Koch Date: Thu, 18 Apr 2013 14:40:43 +0200 Subject: [PATCH] doc: Formatting fixes. * doc/Makefile.am (.fig.jpg): Correct to use -L jpeg. * doc/gpg.texi: Fix cross reference for --options. * doc/gpgsm.texi: Likewise. * doc/gpl.texi: Fix enumerate and re-indent examples. -- Reported-by: Ian Abbott Signed-off-by: Werner Koch --- THANKS | 1 + doc/Makefile.am | 2 +- doc/gpg.texi | 6 ++---- doc/gpgsm.texi | 5 +++-- doc/gpl.texi | 27 +++++++++++++++++---------- 5 files changed, 24 insertions(+), 17 deletions(-) diff --git a/THANKS b/THANKS index 5bde9f33e..d36670735 100644 --- a/THANKS +++ b/THANKS @@ -105,6 +105,7 @@ Holger Smolinski smolinsk at de.ibm.com Holger Trapp Holger.Trapp at informatik.tu-chemnitz.de Hugh Daniel hugh at toad.com Huy Le huyle at ugcs.caltech.edu +Ian Abbott abbotti at mev.co.uk Ian McKellar imckellar at harvestroad.com.au Ingo Klöcker kloecker at kde.org Ivo Timmermans itimmermans at bigfoot.com diff --git a/doc/Makefile.am b/doc/Makefile.am index 17d5997fd..4d6d47572 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -88,7 +88,7 @@ yat2m: yat2m.c fig2dev -L png `test -f '$<' || echo '$(srcdir)/'`$< $@ .fig.jpg: - fig2dev -L jpg `test -f '$<' || echo '$(srcdir)/'`$< $@ + fig2dev -L jpeg `test -f '$<' || echo '$(srcdir)/'`$< $@ .fig.eps: fig2dev -L eps `test -f '$<' || echo '$(srcdir)/'`$< $@ diff --git a/doc/gpg.texi b/doc/gpg.texi index 71941127d..cec458158 100644 --- a/doc/gpg.texi +++ b/doc/gpg.texi @@ -1293,9 +1293,7 @@ encoded in the character set as specified by @option{--display-charset}. These options affect all following arguments. Both options may be used multiple times. -@ifset gpgone -@anchor{option --options} -@end ifset +@anchor{gpg-option --options} @item --options @code{file} @opindex options Read options from @code{file} and do not try to read them from the @@ -2929,7 +2927,7 @@ current home directory (@pxref{option --homedir}). This is the standard configuration file read by @command{@gpgname} on startup. It may contain any valid long option; the leading two dashes may not be entered and the option may not be abbreviated. This default - name may be changed on the command line (@pxref{option --options}). + name may be changed on the command line (@pxref{gpg-option --options}). You should backup this file. @end table diff --git a/doc/gpgsm.texi b/doc/gpgsm.texi index bdb03783e..6a84391e3 100644 --- a/doc/gpgsm.texi +++ b/doc/gpgsm.texi @@ -319,6 +319,7 @@ in the option file. @table @gnupgtabopt +@anchor{gpgsm-option --options} @item --options @var{file} @opindex options Reads configuration from @var{file} instead of from the default @@ -760,8 +761,8 @@ current home directory (@pxref{option --homedir}). This is the standard configuration file read by @command{gpgsm} on startup. It may contain any valid long option; the leading two dashes may not be entered and the option may not be abbreviated. This default -name may be changed on the command line (@pxref{option - --options}). You should backup this file. +name may be changed on the command line (@pxref{gpgsm-option --options}). +You should backup this file. @item policies.txt diff --git a/doc/gpl.texi b/doc/gpl.texi index 7f9a48a13..d13e9e4ab 100644 --- a/doc/gpl.texi +++ b/doc/gpl.texi @@ -228,7 +228,7 @@ terms of section 4, provided that you also meet all of these conditions: @enumerate a -@item +@item The work must carry prominent notices stating that you modified it, and giving a relevant date. @@ -659,12 +659,15 @@ 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 + @iftex @heading END OF TERMS AND CONDITIONS @end iftex @ifinfo @center END OF TERMS AND CONDITIONS @end ifinfo + @unnumberedsec How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest @@ -675,9 +678,11 @@ 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.} +the ``copyright'' line and a pointer to where the full notice is +found. + +@example +@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 @@ -692,17 +697,21 @@ 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 +@end example +@noindent Also add information on how to contact you by electronic and paper mail. +@noindent 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. +@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 @@ -721,5 +730,3 @@ 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}. - -@end enumerate