Bug#981171: [PATCH 12/13] Introduce the user custumization section

2021-01-28 Thread Michael Kerrisk (man-pages)
Hello Bastien.

On 1/27/21 4:48 PM, roucaries.bast...@gmail.com wrote:
> From: Bastien Roucariès 


Again, a much better commit message is needed here, to explain what 
you are doing, and why.

> Signed-off-by: Bastien Roucariès 
> ---
>  man7/environ.7 | 74 ++
>  1 file changed, 39 insertions(+), 35 deletions(-)
> 
> diff --git a/man7/environ.7 b/man7/environ.7
> index 236025035..b461e93df 100644
> --- a/man7/environ.7
> +++ b/man7/environ.7
> @@ -82,7 +82,7 @@ command-line arguments specific to a particular use of the 
> program
>  being invoked, thus changing the program's behavior for this use case.
>  The environment, on the other hand, keeps track of information that is 
> shared by many programs and
>  rarely changes. For example, a running process can query the value of the
> -.B TMDIR
> +.B TMPDIR

This is a change completely unrelated to the commit message.
Also, it's actually a fix to a typo introduced in an earlier
patch (08) in this series. Please don't do this sort of thing.
If an earlier patch was broken, please fix that patch.

>  environment variable to discover a suitable location to store temporary 
> files.
>  .PP
>  Standard environment variables are used for information about the user' home 
> directory,
> @@ -161,15 +161,15 @@ Common examples of environment variables defined by 
> POSIX.1-2017 are defined in
>  section. Conforming applications shall not set these environment variables 
> to have
>  meanings other than as described.
>  .TP
> +.B HOME
> +A user's login directory.
> +Set at login time, see section NOTES below.
> +.TP
>  .B LOGNAME
>  The name of the logged-in user (used by some System-V derived programs
>  and POSIX.1-2017).
>  Set at login time, see section NOTES below.
>  .TP
> -.B HOME
> -A user's login directory.
> -Set at login time, see section NOTES below.
> -.TP
>  .B PATH
>  The list of places that shells and other programs look in to find
>  a command when given an incomplete pathname. Elements on this
> @@ -204,26 +204,16 @@ Set at login time, see section NOTES below.
>  .B TERM
>  The terminal type for which output is to be prepared.
>  .TP
> -.B PAGER
> -The user's preferred utility to display text files.
> -Any string acceptable as a command_string operand to the
> -.I sh\ \-c
> -command shall be valid. If the
> -.B PAGER
> -variable is null or not set,
> -command could fall back
> -.B more (1)
> -or any suitable paging utility as the system default.
> -.TP
> -.BR EDITOR / VISUAL
> -The user's preferred utility to edit text files.
> -Any string acceptable as a command_string operand to the
> -.I sh\ \-c
> -command shall be valid.
> -.\" .TP
> -.\" .B BROWSER
> -.\" The user's preferred utility to browse URLs. Sequence of colon-separated
> -.\" browser commands. See http://www.catb.org/\(tiesr/BROWSER/ .
> +.B TMPDIR
> +The current temporary directory.
> +Influences the path prefix of names created by
> +.BR mktemp (1),
> +.BR mkstemp (3),
> +.BR mkdtemp (3),

TMPDIR does not influence the above three, as far as I know. See my 
comments in patch 01.

> +.BR tmpfile (3),
> +and other routines, and the temporary directory used by
> +.BR sort (1)
> +and other programs.
>  .SH INTERNATIONALIZATION ENVIRONMENT VARIABLES
>  .TP
>  .B LANG
> @@ -247,21 +237,35 @@ for further details of the
>  and
>  .B LC_*
>  environment variables.
> +.SH USER CUSTOMIZATION ENVIRONMENT VARIABLES
> +The following variables are commonly used for personalizing
> +applications used by the user.
> +.TP
> +.B PAGER
> +The user's preferred utility to display text files.
> +Any string acceptable as a command_string operand to the
> +.I sh\ \-c
> +command shall be valid. If the
> +.B PAGER
> +variable is null or not set,
> +command could fall back
> +.B more (1)
> +or any suitable paging utility as the system default.
> +.TP
> +.BR EDITOR / VISUAL
> +The user's preferred utility to edit text files.
> +Any string acceptable as a command_string operand to the
> +.I sh\ \-c
> +command shall be valid. Defined by POSIX.1-2017.
> +.\" .TP
> +.\" .B BROWSER
> +.\" The user's preferred utility to browse URLs. Sequence of colon-separated
> +.\" browser commands. See http://www.catb.org/\(tiesr/BROWSER/ .
>  .SH COMMON ENVIRONMENT VARIABLES
>  Note that the behavior of many programs and library routines is
>  influenced by the presence or value of certain environment variables.
>  Examples include the following:
>  .IP * 3
> -.B TMPDIR
> -influences the path prefix of names created by
> -.BR mktemp (1),
> -.BR mkstemp (3),
> -.BR mkdtemp (3),
> -.BR tmpfile (3),
> -and other routines, and the temporary directory used by
> -.BR sort (1)
> -and other programs.
> -.IP *
>  .BR LD_LIBRARY_PATH ", " LD_PRELOAD ,
>  and other
>  .BR LD_*

Thanks,

Michael


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/



Bug#981171: [PATCH 12/13] Introduce the user custumization section

2021-01-27 Thread roucaries . bastien
From: Bastien Roucariès 

Signed-off-by: Bastien Roucariès 
---
 man7/environ.7 | 74 ++
 1 file changed, 39 insertions(+), 35 deletions(-)

diff --git a/man7/environ.7 b/man7/environ.7
index 236025035..b461e93df 100644
--- a/man7/environ.7
+++ b/man7/environ.7
@@ -82,7 +82,7 @@ command-line arguments specific to a particular use of the 
program
 being invoked, thus changing the program's behavior for this use case.
 The environment, on the other hand, keeps track of information that is shared 
by many programs and
 rarely changes. For example, a running process can query the value of the
-.B TMDIR
+.B TMPDIR
 environment variable to discover a suitable location to store temporary files.
 .PP
 Standard environment variables are used for information about the user' home 
directory,
@@ -161,15 +161,15 @@ Common examples of environment variables defined by 
POSIX.1-2017 are defined in
 section. Conforming applications shall not set these environment variables to 
have
 meanings other than as described.
 .TP
+.B HOME
+A user's login directory.
+Set at login time, see section NOTES below.
+.TP
 .B LOGNAME
 The name of the logged-in user (used by some System-V derived programs
 and POSIX.1-2017).
 Set at login time, see section NOTES below.
 .TP
-.B HOME
-A user's login directory.
-Set at login time, see section NOTES below.
-.TP
 .B PATH
 The list of places that shells and other programs look in to find
 a command when given an incomplete pathname. Elements on this
@@ -204,26 +204,16 @@ Set at login time, see section NOTES below.
 .B TERM
 The terminal type for which output is to be prepared.
 .TP
-.B PAGER
-The user's preferred utility to display text files.
-Any string acceptable as a command_string operand to the
-.I sh\ \-c
-command shall be valid. If the
-.B PAGER
-variable is null or not set,
-command could fall back
-.B more (1)
-or any suitable paging utility as the system default.
-.TP
-.BR EDITOR / VISUAL
-The user's preferred utility to edit text files.
-Any string acceptable as a command_string operand to the
-.I sh\ \-c
-command shall be valid.
-.\" .TP
-.\" .B BROWSER
-.\" The user's preferred utility to browse URLs. Sequence of colon-separated
-.\" browser commands. See http://www.catb.org/\(tiesr/BROWSER/ .
+.B TMPDIR
+The current temporary directory.
+Influences the path prefix of names created by
+.BR mktemp (1),
+.BR mkstemp (3),
+.BR mkdtemp (3),
+.BR tmpfile (3),
+and other routines, and the temporary directory used by
+.BR sort (1)
+and other programs.
 .SH INTERNATIONALIZATION ENVIRONMENT VARIABLES
 .TP
 .B LANG
@@ -247,21 +237,35 @@ for further details of the
 and
 .B LC_*
 environment variables.
+.SH USER CUSTOMIZATION ENVIRONMENT VARIABLES
+The following variables are commonly used for personalizing
+applications used by the user.
+.TP
+.B PAGER
+The user's preferred utility to display text files.
+Any string acceptable as a command_string operand to the
+.I sh\ \-c
+command shall be valid. If the
+.B PAGER
+variable is null or not set,
+command could fall back
+.B more (1)
+or any suitable paging utility as the system default.
+.TP
+.BR EDITOR / VISUAL
+The user's preferred utility to edit text files.
+Any string acceptable as a command_string operand to the
+.I sh\ \-c
+command shall be valid. Defined by POSIX.1-2017.
+.\" .TP
+.\" .B BROWSER
+.\" The user's preferred utility to browse URLs. Sequence of colon-separated
+.\" browser commands. See http://www.catb.org/\(tiesr/BROWSER/ .
 .SH COMMON ENVIRONMENT VARIABLES
 Note that the behavior of many programs and library routines is
 influenced by the presence or value of certain environment variables.
 Examples include the following:
 .IP * 3
-.B TMPDIR
-influences the path prefix of names created by
-.BR mktemp (1),
-.BR mkstemp (3),
-.BR mkdtemp (3),
-.BR tmpfile (3),
-and other routines, and the temporary directory used by
-.BR sort (1)
-and other programs.
-.IP *
 .BR LD_LIBRARY_PATH ", " LD_PRELOAD ,
 and other
 .BR LD_*
-- 
2.29.2