From c5e4849ee8d91f8a22168e689e01eb5369839e75 Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@operamail.com>
Date: Sat, 1 Sep 2012 05:11:07 +0200
Subject: installation doc update + more installation options alternatives + m

---
 manuals/ponysay.texinfo | 229 ++++++++++++++++++++++++++++++++++++------------
 1 file changed, 173 insertions(+), 56 deletions(-)

(limited to 'manuals/ponysay.texinfo')

diff --git a/manuals/ponysay.texinfo b/manuals/ponysay.texinfo
index a50d862..6f530b9 100644
--- a/manuals/ponysay.texinfo
+++ b/manuals/ponysay.texinfo
@@ -8,7 +8,7 @@
 @documentlanguage en
 @finalout
 @c %**end of header
-@set VERSION 2.5
+@set VERSION 2.6
 
 @copying
 This manual is for ponysay
@@ -640,7 +640,7 @@ We have provided a script that should run one most, if not all shells, named
 @table @command
 @item coreutils
 @command{stty} is used to determine the size of the terminal.
-@item python>=3
+@item python>=3@footnote{Sometimes distributed as @command{python3} rather than @command{python}.}
 @command{ponysay} is written in pure Python 3.
 @end table
 
@@ -672,7 +672,7 @@ the file name) in addition to .pony-files or pony names.
 @section Package building dependencies
 
 @table @command
-@item python>=3
+@item python>=3@footnote{Sometimes distributed as @command{python3} rather than @command{python}.}
 Required to run the @file{./setup.py} file, which is also invoked from the
 make script.
 @item gzip
@@ -681,20 +681,11 @@ Used for compressing manuals. (Optional, standard)
 Used for compressing manuals. (Optional, non-standard)
 @item texinfo
 Used to compile this @command{info} manual. (Optional, standard)
-@item info
+@item info@footnote{Normally a part of @command{texinfo}.}
 Used to install this @command{info} manual with @command{install-info}.
 (Optional, standard)
-@item make
-Required to run the make script. (Optional)
-@item sh
-Required to run the @command{./configure} script. (Optional)
-@item sed
-Used in the @command{./configure} script. (Optional)
 @end table
 
-Note that @command{info} may actually be a part of @command{texinfo};
-@command{sh} should be provided another shell, such as @command{bash}.
-
 
 @node Dependencies for pony providers
 @section Dependencies for pony providers
@@ -736,6 +727,8 @@ It can be downloaded at @url{https://github.com/maandree/util-say}.
 
 @node Installations basics
 @subsection Installations basics
+@cindex @file{setup.py}
+@cindex @command{./setup.py}
 @cindex @command{make}
 @cindex basic installation
 
@@ -751,9 +744,9 @@ If you have @command{git} you can @command{clone} the project URL
 @url{https://github.com/erkin/ponysay.git}.
 
 In the terminal, @command{cd} into the ponysay directory and execute
-@command{./configure && make install}. This will install @command{ponysay} into
-@file{/usr}, normally meaning you need to run @command{make install} as root,
-e.g. by running @command{sudo make install}.
+@command{./setup.py install} or @command{python3 setup.py install}. This will install
+@command{ponysay} into @file{/usr}, normally meaning you need to run as root, e.g. by
+running @command{sudo ./setup.py install}.
 
 Now you will be to use ponysay, run: @command{ponysay "I am just the cutest pony!"},
 or if have a specific pony in your mind: @command{ponysay -f pinkie "Partay!~"}.
@@ -764,14 +757,6 @@ or if have a specific pony in your mind: @command{ponysay -f pinkie "Partay!~"}.
 in Spanish: @command{man -L es 6 ponysay}. To install the Spanish manual add the
 option @option{--with-man-es} when running @command{./configure}.
 
-@cindex @file{setup.py}
-@cindex @command{./setup.py}
-If your system does not have @command{sh}, @command{make} or @command{sed} or can
-use @command{./setup.py OPTIONS VERB} or @command{python3 setup.py OPTIONS VERB}
-(or @command{python} instead of @command{python3}) instead of
-@command{./configure OPTIONS && make VERB}. @command{./setup.py} recognised
-@command{./setup.py version} and @command{./setup.py help}, which is not supported
-by @command{make} or @command{./configure}.
 
 
 @node Custom installations
@@ -784,14 +769,12 @@ by @command{make} or @command{./configure}.
 @cindex make
 @cindex configure
 
-@command{./configure} and @command{./setup.py} and recognises the same options.
-Whether the exception for with @option{--with-everything} and
-@option{--with-nothing}, every option that starts with @option{--with-} or
-@option{--without-} exists in both variants. @option{--with-} options install
-parts of the package. @option{--without-} options skipps installation of parts
-of the packages. With the same exception, @option{--without-} options take not
-arguments and @option{--with-} optionally takes an argument, if no argument is
-provided a default argument is implied.
+With the exception for with @option{--with-everything} and @option{--with-nothing},
+every option that starts with @option{--with-} or @option{--without-} exists in both
+variants. @option{--with-} options install parts of the package. @option{--without-}
+options skips installation of parts of the packages. With the same exception,
+@option{--without-} options take not arguments and @option{--with-} optionally takes
+an argument, if no argument is provided a default argument is implied.
 
 The configuration script recognised the following options, the default values for
 options with arguments are written after the equality sign (@code{=}) in the option:
@@ -814,14 +797,20 @@ this means that the commands, xterm ponies and legal documents is installed.
 @cindex @option{--with-nothing}
 Install nothing, except legal documents, that is not explicity included.
 
-@item --with-ponysay=/usr/bin/ponysay
+@item --with-ponysay
+@itemx --with-ponysay-command=/usr/bin/ponysay
 @cindex @option{--with-ponysay}
 @cindex @option{--without-ponysay}
+@cindex @option{--with-ponysay-command}
+@cindex @option{--without-ponysay-command}
 Install the ponysay command, and set file name. (Default)
 
-@item --with-ponythink=/usr/bin/ponythink
+@item --with-ponythink
+@itemx --with-ponythink-command=/usr/bin/ponythink
 @cindex @option{--with-ponythink}
 @cindex @option{--without-ponytink}
+@cindex @option{--with-ponythink-command}
+@cindex @option{--without-ponytink-command}
 Install the ponythink command, and set file name. (Default)
 
 @item --with-shared-cache=/var/cache/ponysay
@@ -829,28 +818,38 @@ Install the ponythink command, and set file name. (Default)
 @cindex @option{--without-shared-cache}
 Install a user shared cache, this is only used by KMS ponies so far. (Default)
 
-@item --with-bash=/usr/share/bash-completion/completions/ponysay
+@item --with-bash
+@item --with-bash-completion=/usr/share/bash-completion/completions/ponysay
 @cindex @option{--with-bash}
 @cindex @option{--without-bash}
+@cindex @option{--with-bash-completion}
+@cindex @option{--without-bash-completion}
 Install auto-completion for installed commands in GNU Bash. Select the file name
 for the installed script for the ponysay command, the other commands modifies this
 file name. (Default)
 
-@item --with-fish=/usr/share/fish/completions/ponysay.fish
+@item --with-fish
+@itemx --with-fish-completion=/usr/share/fish/completions/ponysay.fish
 @cindex @option{--with-fish}
 @cindex @option{--without-fish}
+@cindex @option{--with-fish-completion}
+@cindex @option{--without-fish-completion}
 Install auto-completion for installed commands in Friendly interactive shell.
 Select the file name for the installed script for the ponysay command, the other
 commands modifies this file name. (Default)
 
-@item --with-zsh=/usr/share/zsh/site-functions/_ponysay
+@item --with-zsh
+@itemx --with-zsh-completion=/usr/share/zsh/site-functions/_ponysay
 @cindex @option{--with-zsh}
 @cindex @option{--without-zsh}
+@cindex @option{--with-zsh-completion}
+@cindex @option{--without-zsh-completion}
 Install auto-completion for installed commands in the zsh shell.
 Select the file name for the installed script for the ponysay command, the other
 commands modifies this file name. (Default)
 
-@item --with-shell=/usr/share
+@item --with-shell
+@itemx --with-shell-completion=/usr/share
 @cindex @option{--with-shell}
 @cindex @option{--without-shell}
 @cindex @option{--with-bash}
@@ -859,83 +858,198 @@ commands modifies this file name. (Default)
 @cindex @option{--without-fish}
 @cindex @option{--with-zsh}
 @cindex @option{--without-zsh}
+@cindex @option{--with-shell-completion}
+@cindex @option{--without-shell-completion}
+@cindex @option{--with-bash-completion}
+@cindex @option{--without-bash-completion}
+@cindex @option{--with-fish-completion}
+@cindex @option{--without-fish-completion}
+@cindex @option{--with-zsh-completion}
+@cindex @option{--without-zsh-completion}
 Macro for @option{--with-bash}, @option{--with-fish} and @option{--with-zsh}.
 The argument is the used share/ directory that all shells have in common.
 
-@item --with-pdf=/usr/doc
+@item --with-pdf
+@itemx --with-pdf-manual=/usr/doc
 @cindex @option{--with-pdf}
 @cindex @option{--without-pdf}
+@cindex @option{--with-pdf-manual}
+@cindex @option{--without-pdf-manual}
 Install PDF manual, and select directory for it.
 
-@item --with-pdf-compression=gz
+@item --with-pdf-compression
+@itemx --with-pdf-manual-compression=gz
 @cindex @option{--with-pdf}
+@cindex @option{--with-pdf-manual}
 @cindex @option{--with-pdf-compression}
 @cindex @option{--without-pdf-compression}
+@cindex @option{--with-pdf-manual-compression}
+@cindex @option{--without-pdf-manual-compression}
 Compress PDF manual, select compression by file name extension. This option
 does not imply @option{--with-pdf}. (Default)
 
-@item --with-info=/usr/share/info
+@item --with-info
+@itemx --with-info-manual=/usr/share/info
 @cindex @option{--with-info}
 @cindex @option{--without-info}
+@cindex @option{--with-info-manual}
+@cindex @option{--without-info-manual}
 Install @command{info} manual, and select directory for it. (Default)
 
-@item --with-info-install=My Little Ponies for your terminal
+@item --with-info-install
+@itemx --with-info-manual-install=My Little Ponies for your terminal
 @cindex @option{--with-info-install}
 @cindex @option{--without-info-install}
+@cindex @option{--with-info-manual-install}
+@cindex @option{--without-info-manual-install}
 Use @command{install-info} when installing @command{info} manual. Set the
 description for the manual. This option does not imply @option{--with-info}. (Default)
 
-@item --with-info-compression=gz
+@item --with-info-compression
+@itemx --with-info-manual-compression=gz
 @cindex @option{--with-info}
 @cindex @option{--with-info-compression}
 @cindex @option{--without-info-compression}
+@cindex @option{--with-info-manual}
+@cindex @option{--with-info-manual-compression}
+@cindex @option{--without-info-manual-compression}
 Compress @command{info} manual, select compression by file name extension.
 This option does not imply @option{--with-info}. (Default)
 
-@item --with-man-en=/usr/share/man
+@item --with-man-en
+@itemx --with-manpage-en
+@itemx --with-man-manual-en
+@itemx --with-en-man
+@itemx --with-en-manpage
+@itemx --with-en-man-manual=/usr/share/man
 @cindex @option{--with-man-en}
 @cindex @option{--without-man-en}
+@cindex @option{--with-manpage-en}
+@cindex @option{--without-manpage-en}
+@cindex @option{--with-man-manual-en}
+@cindex @option{--without-man-manual-en}
+@cindex @option{--with-en-man}
+@cindex @option{--without-en-man}
+@cindex @option{--with-en-manpage}
+@cindex @option{--without-en-manpage}
+@cindex @option{--with-en-man-manual}
+@cindex @option{--without-en-man-manual}
 Install English @command{man} manual. Set directory for @command{man} manuals.
 (Default)
 
-@item --with-man-es=/usr/share/man
+@item --with-man-es
+@itemx --with-manpage-es
+@itemx --with-man-manual-es
+@itemx --with-es-man
+@itemx --with-es-manpage
+@itemx --with-es-man-manual=/usr/share/man
 @cindex @option{--with-man-es}
 @cindex @option{--without-man-es}
+@cindex @option{--with-manpage-es}
+@cindex @option{--without-manpage-es}
+@cindex @option{--with-man-manual-es}
+@cindex @option{--without-man-manual-es}
+@cindex @option{--with-es-man}
+@cindex @option{--without-es-man}
+@cindex @option{--with-es-manpage}
+@cindex @option{--without-es-manpage}
+@cindex @option{--with-es-man-manual}
+@cindex @option{--without-es-man-manual}
 Install Spanish @command{man} manual. Set directory for @command{man} manuals.
 
 @item --with-man
+@itemx --with-manpage
+@itemx --with-man-manual
 @cindex @option{--with-man}
 @cindex @option{--without-man}
+@cindex @option{--with-manpage}
+@cindex @option{--without-manpage}
+@cindex @option{--with-man-manual}
+@cindex @option{--without-man-manual}
 Macro for all @option{--with-man-LANG}.
 
-@item --with-man-en-compression=gz
+@item --with-man-en-compression
+@itemx --with-manpage-en-compression
+@itemx --with-man-manual-en-compression
+@itemx --with-en-man-compression
+@itemx --with-en-manpage-compression
+@itemx --with-en-man-manual-compression=gz
 @cindex @option{--with-man-en-compression}
 @cindex @option{--without-man-en-compression}
+@cindex @option{--with-manpage-en-compression}
+@cindex @option{--without-manpage-en-compression}
+@cindex @option{--with-man-manual-en-compression}
+@cindex @option{--without-man-manual-en-compression}
+@cindex @option{--with-en-man-compression}
+@cindex @option{--without-en-man-compression}
+@cindex @option{--with-en-manpage-compression}
+@cindex @option{--without-en-manpage-compression}
+@cindex @option{--with-en-man-manual-compression}
+@cindex @option{--without-en-man-manual-compression}
 Compress English @command{man} manual, select compression by file name extension.
 This option does not imply @option{--with-man-en}. (Default)
 
-@item --with-man-es-compression=gz
+@item --with-man-es-compression
+@itemx --with-manpage-es-compression
+@itemx --with-man-manual-es-compression
+@itemx --with-es-man-compression
+@itemx --with-es-manpage-compression
+@itemx --with-es-man-manual-compression=gz
 @cindex @option{--with-man-es-compression}
 @cindex @option{--without-man-es-compression}
+@cindex @option{--with-manpage-es-compression}
+@cindex @option{--without-manpage-es-compression}
+@cindex @option{--with-man-manual-es-compression}
+@cindex @option{--without-man-manual-es-compression}
+@cindex @option{--with-es-man-compression}
+@cindex @option{--without-es-man-compression}
+@cindex @option{--with-es-manpage-compression}
+@cindex @option{--without-es-manpage-compression}
+@cindex @option{--with-es-man-manual-compression}
+@cindex @option{--without-es-man-manual-compression}
 Compress Spanish @command{man} manual, select compression by file name extension.
 This option does not imply @option{--with-man-es}. (Default)
 
 @item --with-man-compression
+@itemx --with-manpage-compression
+@itemx --with-man-manual-compression
 @cindex @option{--with-man-compression}
 @cindex @option{--without-man-compression}
+@cindex @option{--with-manpage-compression}
+@cindex @option{--without-manpage-compression}
+@cindex @option{--with-man-manual-compression}
+@cindex @option{--without-man-manual-compression}
 Macro for all @option{--with-man-LANG-compression}.
 
-@item --man-section-ponysay=6
+@item --man-section-ponysay
+@itemx --man-sectionpage-ponysay
+@itemx --ponysay-man-section
+@itemx --ponysay-manpage-section=6
 @cindex @option{--man-section-ponysay}
-Change the section for the ponysay manpage.
-
-@item --man-section-cowsay=1
+@cindex @option{--manpage-section-ponysay}
+@cindex @option{--ponysay-man-section}
+@cindex @option{--ponysay-manpage-section}
+Change the section for the @command{ponysay} manpage.
+
+@item --man-section-cowsay
+@itemx --manpage-section-cowsay
+@itemx --cowsay-man-section
+@itemx --cowsay-manpage-section=1
 @cindex @option{--man-section-cowsay}
-Change the section for the cowsay manpage.
-
-@item --man-section-fortune=6
+@cindex @option{--manpage-section-cowsay}
+@cindex @option{--cowsay-man-section}
+@cindex @option{--cowsay-manpage-section}
+Change the section for the @command{cowsay} manpage.
+
+@item --man-section-fortune
+@itemx --manpage-section-fortune
+@itemx --fortune-man-section
+@itemx --fortune-manpage-section=6
 @cindex @option{--man-section-fortune}
-Change the section for the fortune manpage.
+@cindex @option{--manpage-section-fortune}
+@cindex @option{--fortune-man-section}
+@cindex @option{--fortune-manpage-section}
+Change the section for the @command{fortune} manpage.
 
 @item --with-ponies=/usr/share/ponysay/ponies
 @cindex @option{--with-ponies}
@@ -967,9 +1081,12 @@ Install pony quotes, and select installation directory for them. (Default)
 @cindex @option{--without-balloons}
 Install balloon styles, and select installation directory for them. (Default)
 
-@item --with-ucs=/usr/share/ponysay/ucsmap
+@item --with-ucs
+@itemx --with-ucs-names=/usr/share/ponysay/ucsmap
 @cindex @option{--with-ucs}
 @cindex @option{--without-ucs}
+@cindex @option{--with-ucs-names}
+@cindex @option{--without-ucs-names}
 Install UCS pony names, and select installation file name for the map. (Default)
 
 @item --without-custom-env-python
-- 
cgit