From 9c2989e1a461fc76aa2f80d85d86d69fd7f61c54 Mon Sep 17 00:00:00 2001 From: Nate Bargmann Date: Sat, 16 Jan 2016 09:17:39 -0600 Subject: [PATCH] Favor $HOME over '~' in text As perhaps not all shells support '~' as a shortcut for $HOME, use $HOME instead to clarify text. --- doc/getting_started.texi | 11 ++++++++++- doc/utility_programs.texi | 36 ++++++++++++++++++------------------ 2 files changed, 28 insertions(+), 19 deletions(-) diff --git a/doc/getting_started.texi b/doc/getting_started.texi index c55b5bf73..1213bc263 100644 --- a/doc/getting_started.texi +++ b/doc/getting_started.texi @@ -231,9 +231,18 @@ system hierarchy. Perhaps you want to install to your home directory instead: @example -@command{./configure --prefix=~/local} +@command{./configure --prefix=$HOME/local} @end example +@quotation Note +For practice you may wish to start out using the +@samp{--prefix=$HOME/local} option to install the Hamlib files into +your home directory and avoid overwriting any version of Hamlib +installed into the system directories. The code examples in the +remainder of this manual will assume Hamlib has been installed to +@samp{$HOME/local}. +@end quotation + All of the files will be installed in the @file{local} directory of your home directory. @file{local} will be created if it does not exist during installation as will several other directories in it. diff --git a/doc/utility_programs.texi b/doc/utility_programs.texi index 98886fb5a..d14b6bc6c 100644 --- a/doc/utility_programs.texi +++ b/doc/utility_programs.texi @@ -374,27 +374,27 @@ using @command{rigctl} to turn AI mode on or off, pass this option. @item -i @itemx --read-history Read previously saved command and argument history from a file -(default '@file{~/.rigctl_history}') for the current session. +(default '@file{$HOME/.rigctl_history}') for the current session. Available when @command{rigctl} is built with Readline support. @strong{N.B.} To read a history file stored in another directory, set the @env{RIGCTL_HIST_DIR} environment variable, e.g.@: -'@kbd{RIGCTL_HIST_DIR=~/tmp rigctl -i}'. When @env{RIGCTL_HIST_DIR} -is not set, the value of @env{HOME} is used. +'@kbd{RIGCTL_HIST_DIR=$HOME/tmp rigctl -i}'. When +@env{RIGCTL_HIST_DIR} is not set, the value of @env{HOME} is used. @item -I @itemx --save-history Write current session (and previously saved session(s) if @option{-i} option is also given) command and argument history to a file (default -'@file{~/.rigctl_history}') at the end of the current session. +'@file{$HOME/.rigctl_history}') at the end of the current session. Complete commands with arguments are saved as a single line to be recalled and used or edited. Available when @command{rigctl} is built with Readline support. To write a history file in another directory, set the @env{RIGCTL_HIST_DIR} environment variable, e.g.@: -'@kbd{RIGCTL_HIST_DIR=~/tmp rigctl -I}'. When @env{RIGCTL_HIST_DIR} -is not set, the value of @env{HOME} is used. +'@kbd{RIGCTL_HIST_DIR=$HOME/tmp rigctl -I}'. When +@env{RIGCTL_HIST_DIR} is not set, the value of @env{HOME} is used. @item -v @itemx --verbose @@ -1006,7 +1006,7 @@ their defaults as described in the @url{http://cnswww.cns.cwru.edu/php/chet/readline/rluserman.html, Readline manual} although @command{rigctl} sets the name @code{rigctl} which can be used in @code{Conditional Init Constructs} in the -Readline Init File (@file{~/.inputrc} by default) for custom +Readline Init File (@file{$HOME/.inputrc} by default) for custom keybindings unique to @command{rigctl}. Command history is available with Readline support as described in the @@ -1028,12 +1028,12 @@ This is useful to save a set of commands and then read them later but not write the modified history for a consistent set of test commands in interactive mode, for example. -History is stored in @file{~/.rigctl_history} by default although the -destination directory may be changed by setting the +History is stored in @file{$HOME/.rigctl_history} by default although +the destination directory may be changed by setting the @env{RIGCTL_HIST_DIR} environment variable. When -@env{RIGCTL_HIST_DIR} is unset, the value of the @env{HOME} environment -variable is used instead. Only the destination directory may be -changed at this time. +@env{RIGCTL_HIST_DIR} is unset, the value of the @env{HOME} +environment variable is used instead. Only the destination directory +may be changed at this time. If Readline support is not found at configure time the original internal command handler is used. Readline is not used for @@ -1313,26 +1313,26 @@ exit. @item -i @itemx --read-history Read previously saved command and argument history from a file -(default '@file{~/.rotctl_history}') for the current session. +(default '@file{$HOME/.rotctl_history}') for the current session. Available when @command{rotctl} is built with Readline support. @strong{N.B.} To read a history file stored in another directory, set the @env{ROTCTL_HIST_DIR} environment variable, e.g.@: -'@kbd{ROTCTL_HIST_DIR=~/tmp rotctl -i}'. When @env{ROTCTL_HIST_DIR} +'@kbd{ROTCTL_HIST_DIR=$HOME/tmp rotctl -i}'. When @env{ROTCTL_HIST_DIR} is not set, the value of @env{HOME} is used. @item -I @itemx --save-history Write current session (and previously saved session(s) if @option{-i} option is also given) command and argument history to a file (default -'@file{~/.rotctl_history}') at the end of the current session. +'@file{$HOME/.rotctl_history}') at the end of the current session. Complete commands with arguments are saved as a single line to be recalled and used or edited. Available when @command{rotctl} is built with Readline support. To write a history file in another directory, set the @env{ROTCTL_HIST_DIR} environment variable, e.g.@: -'@kbd{ROTCTL_HIST_DIR=~/tmp rotctl -I}'. When @env{ROTCTL_HIST_DIR} +'@kbd{ROTCTL_HIST_DIR=$HOME/tmp rotctl -I}'. When @env{ROTCTL_HIST_DIR} is not set, the value of @env{HOME} is used. @item -v @@ -1538,7 +1538,7 @@ their defaults as described in the @url{http://cnswww.cns.cwru.edu/php/chet/readline/rluserman.html, Readline manual} although @command{rotctl} sets the name @code{rotctl} which can be used in @code{Conditional Init Constructs} in the -Readline Init File (@file{~/.inputrc} by default) for custom +Readline Init File (@file{$HOME/.inputrc} by default) for custom keybindings unique to @command{rotctl}. Command history is available with Readline support as described in the @@ -1560,7 +1560,7 @@ This is useful to save a set of commands and then read them later but not write the modified history for a consistent set of test commands in interactive mode, for example. -History is stored in @file{~/.rotctl_history} by default although the +History is stored in @file{$HOME/.rotctl_history} by default although the destination directory may be changed by setting the @env{ROTCTL_HIST_DIR} environment variable. When @env{ROTCTL_HIST_DIR} is unset, the value of the @env{HOME} environment