Bug#981171: [PATCH 10/13] Introduce ENVIRONMENT 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 

A commit like this deserves a much more detailed commit
message explaining what you are doing and why.
I think there's some good stuff below. but I need a better
commit message, and also this patch probably doesn't apply
without the previous patches.

Thanks,

Michael

> Signed-off-by: Bastien Roucariès 
> ---
>  man7/environ.7 | 92 +++---
>  1 file changed, 49 insertions(+), 43 deletions(-)
> 
> diff --git a/man7/environ.7 b/man7/environ.7
> index f2786fa09..96d47be9f 100644
> --- a/man7/environ.7
> +++ b/man7/environ.7
> @@ -108,7 +108,55 @@ it inherits a
>  .I copy
>  of its parent's environment.
>  .PP
> -Common examples are:
> +Environment variables may be placed in the shell's environment by the
> +.I export
> +command in
> +.BR sh (1),
> +or by the
> +.I setenv
> +command if you use
> +.BR csh (1).
> +.PP
> +The initial environment of the shell is populated in various ways,
> +such as definitions from
> +.IR /etc/environment
> +that are processed by
> +.BR pam_env (8)
> +for all users at login time (on systems that employ
> +.BR pam (8)).
> +In addition, various shell initialization scripts, such as the system-wide
> +.IR /etc/profile
> +script and per-user initialization scripts may include commands
> +that add variables to the shell's environment;
> +see the manual page of your preferred shell for details.
> +.PP
> +Bourne-style shells support the syntax
> +.PP
> +NAME=value command
> +.PP
> +to create an environment variable definition only in the scope
> +of the process that executes
> +.IR command .
> +Multiple variable definitions, separated by white space, may precede
> +.IR command .
> +.PP
> +Arguments may also be placed in the
> +environment at the point of an
> +.BR exec (3).
> +A C program can manipulate its environment using the functions
> +.BR getenv (3),
> +.BR putenv (3),
> +.BR setenv (3),
> +and
> +.BR unsetenv (3).
> +.PP
> +What follows is a list of environment variables typically seen on a
> +system. This list is incomplete and includes only common variables seen
> +by average users in their day-to-day routine.
> +Environment variables specific to a particular program or library function
> +are documented in the ENVIRONMENT section of the appropriate manual page.
> +.SH ENVIRONMENT
> +Common examples of environment variables are:
>  .TP
>  .B USER
>  The name of the logged-in user (used by some BSD-derived programs).
> @@ -196,48 +244,6 @@ command shall be valid.
>  .\" The user's preferred utility to browse URLs. Sequence of colon-separated
>  .\" browser commands. See http://www.catb.org/\(tiesr/BROWSER/ .
>  .PP
> -Names may be placed in the shell's environment by the
> -.I export
> -command in
> -.BR sh (1),
> -or by the
> -.I setenv
> -command if you use
> -.BR csh (1).
> -.PP
> -The initial environment of the shell is populated in various ways,
> -such as definitions from
> -.IR /etc/environment
> -that are processed by
> -.BR pam_env (8)
> -for all users at login time (on systems that employ
> -.BR pam (8)).
> -In addition, various shell initialization scripts, such as the system-wide
> -.IR /etc/profile
> -script and per-user initializations script may include commands
> -that add variables to the shell's environment;
> -see the manual page of your preferred shell for details.
> -.PP
> -Bourne-style shells support the syntax
> -.PP
> -NAME=value command
> -.PP
> -to create an environment variable definition only in the scope
> -of the process that executes
> -.IR command .
> -Multiple variable definitions, separated by white space, may precede
> -.IR command .
> -.PP
> -Arguments may also be placed in the
> -environment at the point of an
> -.BR exec (3).
> -A C program can manipulate its environment using the functions
> -.BR getenv (3),
> -.BR putenv (3),
> -.BR setenv (3),
> -and
> -.BR unsetenv (3).
> -.PP
>  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:
> 


-- 
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 10/13] Introduce ENVIRONMENT section

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

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

diff --git a/man7/environ.7 b/man7/environ.7
index f2786fa09..96d47be9f 100644
--- a/man7/environ.7
+++ b/man7/environ.7
@@ -108,7 +108,55 @@ it inherits a
 .I copy
 of its parent's environment.
 .PP
-Common examples are:
+Environment variables may be placed in the shell's environment by the
+.I export
+command in
+.BR sh (1),
+or by the
+.I setenv
+command if you use
+.BR csh (1).
+.PP
+The initial environment of the shell is populated in various ways,
+such as definitions from
+.IR /etc/environment
+that are processed by
+.BR pam_env (8)
+for all users at login time (on systems that employ
+.BR pam (8)).
+In addition, various shell initialization scripts, such as the system-wide
+.IR /etc/profile
+script and per-user initialization scripts may include commands
+that add variables to the shell's environment;
+see the manual page of your preferred shell for details.
+.PP
+Bourne-style shells support the syntax
+.PP
+NAME=value command
+.PP
+to create an environment variable definition only in the scope
+of the process that executes
+.IR command .
+Multiple variable definitions, separated by white space, may precede
+.IR command .
+.PP
+Arguments may also be placed in the
+environment at the point of an
+.BR exec (3).
+A C program can manipulate its environment using the functions
+.BR getenv (3),
+.BR putenv (3),
+.BR setenv (3),
+and
+.BR unsetenv (3).
+.PP
+What follows is a list of environment variables typically seen on a
+system. This list is incomplete and includes only common variables seen
+by average users in their day-to-day routine.
+Environment variables specific to a particular program or library function
+are documented in the ENVIRONMENT section of the appropriate manual page.
+.SH ENVIRONMENT
+Common examples of environment variables are:
 .TP
 .B USER
 The name of the logged-in user (used by some BSD-derived programs).
@@ -196,48 +244,6 @@ command shall be valid.
 .\" The user's preferred utility to browse URLs. Sequence of colon-separated
 .\" browser commands. See http://www.catb.org/\(tiesr/BROWSER/ .
 .PP
-Names may be placed in the shell's environment by the
-.I export
-command in
-.BR sh (1),
-or by the
-.I setenv
-command if you use
-.BR csh (1).
-.PP
-The initial environment of the shell is populated in various ways,
-such as definitions from
-.IR /etc/environment
-that are processed by
-.BR pam_env (8)
-for all users at login time (on systems that employ
-.BR pam (8)).
-In addition, various shell initialization scripts, such as the system-wide
-.IR /etc/profile
-script and per-user initializations script may include commands
-that add variables to the shell's environment;
-see the manual page of your preferred shell for details.
-.PP
-Bourne-style shells support the syntax
-.PP
-NAME=value command
-.PP
-to create an environment variable definition only in the scope
-of the process that executes
-.IR command .
-Multiple variable definitions, separated by white space, may precede
-.IR command .
-.PP
-Arguments may also be placed in the
-environment at the point of an
-.BR exec (3).
-A C program can manipulate its environment using the functions
-.BR getenv (3),
-.BR putenv (3),
-.BR setenv (3),
-and
-.BR unsetenv (3).
-.PP
 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:
-- 
2.29.2