Hello Bastien, In general, I like this idea, but may I ask you to rework the patch a little. Could you please fix up the pieces below (I'm sorry, you'll also need to rebase, because of other changes that I've made), and resubmit?
On 1/30/21 12:29 AM, roucaries.bast...@gmail.com wrote: > From: Bastien Roucariès <ro...@debian.org> > > In order to improve readability create four subsections: > - POSIX defined core environment variables, for variables defined by POSIX > that How about just "POSIX-defined environment variables". I not sure that "core" adds anything here. > modify the general behavior of a program > - Internationalization environment variables for variables related to > internationalization > - User customization environment variables for personnalizing application to > user taste. > - Other common environment variables for other common variables> > Move USER to other because this variable is not defined by POSIX > > Signed-off-by: Bastien Roucariès <ro...@debian.org> > --- > man7/environ.7 | 123 ++++++++++++++++++++++++++----------------------- > 1 file changed, 66 insertions(+), 57 deletions(-) > > diff --git a/man7/environ.7 b/man7/environ.7 > index 9fd3f727f..45204438f 100644 > --- a/man7/environ.7 > +++ b/man7/environ.7 > @@ -138,38 +138,20 @@ to not conflict with the variables specified in the > next sections. > 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). > -Set at login time, see section NOTES below. > +.SS POSIX defined core environment variables .SS Environment variables specified in POSIX > +Common examples of environment variables defined by POSIX that may modify > the general Source lines should be limited to about 75 columns. > +behavior of a program, are defined in the following section. > +Conforming applications shall not set these environment variables to have > +meanings other than as described. s/meanings/values/ ? > .TP > .B LOGNAME > -The name of the logged-in user (used by some System-V derived programs). > +The name of the logged-in user. This is a change unrelated to the commit message. Why do you want to make this change? > Set at login time, see section NOTES below. > .TP > .B HOME > A user's login directory, set a login time. > Set at login time, see section NOTES below. > .TP > -.B LANG > -The name of a locale to use for locale categories when not overridden > -by > -.B LC_ALL > -or more specific environment variables such as > -.BR LC_COLLATE , > -.BR LC_CTYPE , > -.BR LC_MESSAGES , > -.BR LC_MONETARY , > -.BR LC_NUMERIC , > -and > -.BR LC_TIME > -(see > -.BR locale (7) > -for further details of the > -.BR LC_* > -environment variables). > -.TP > .B PATH > The sequence of directory prefixes that > .BR sh (1) > @@ -207,6 +189,62 @@ Set at login time, see section NOTES below. > .TP > .B TERM > The terminal type for which output is to be prepared. > +.SS Internationalization environment variables > +.TP > +.B LANG > +The name of a locale to use for locale categories when not overridden > +by > +.B LC_ALL > +or more specific environment variables such as > +.B LC_COLLATE , > +.B LC_CTYPE , > +.B LC_MESSAGES , > +.B LC_MONETARY , > +.B LC_NUMERIC , > +and > +.BR LC_TIME. > +See > +.BR catopen (3), > +.BR gettext (3), > +.BR locale (7) > +for further details of the > +.B LANG > +and > +.B LC_* > +environment variables. > +.TP > +.BR TZ/TZDIR > +.B TZ > +variable (in association with > +.B TZDIR) > +gives timezone information used by > +.BR tzset (3) > +and through that by functions like > +.BR ctime (3), > +.BR localtime (3), > +.BR mktime (3), > +.BR strftime (3). > +See also > +.BR tzselect (8). > +.SS User customization environment variables > +The following variables are commonly used for personalizing > +applications used by the user: > +.\" .TP > +.\" .B BROWSER > +.\" The user's preferred utility to browse URLs. Sequence of colon-separated > +.\" browser commands. See http://www.catb.org/\(tiesr/BROWSER/ . > +.TP > +.B COLUMNS/LINES > +The > +.B COLUMNS " and " LINES s/.B/.BR/ > +variables > +tell applications about the window size, possibly overriding the actual size. > +.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 PAGER > The user's preferred utility to display text files. > @@ -218,30 +256,11 @@ variable is null or not set, > command could fallback > .B more (1) > or any suitable paging utility default defined system-wise. > -.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/ . > -.PP > +.SS Other 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 > -The variables > -.BR LANG ", " LANGUAGE ", " NLSPATH ", " LOCPATH , > -.BR LC_ALL ", " LC_MESSAGES , > -and so on influence locale handling; see > -.BR catopen (3), > -.BR gettext (3), > -and > -.BR locale (7). > -.IP * > .B TMPDIR > influences the path prefix of names created by > .BR tempnam (3) > @@ -272,23 +291,13 @@ gives the name of a file containing aliases > to be used with > .BR gethostbyname (3). > .IP * > -.BR TZ " and " TZDIR > -give timezone information used by > -.BR tzset (3) > -and through that by functions like > -.BR ctime (3), > -.BR localtime (3), > -.BR mktime (3), > -.BR strftime (3). > -See also > -.BR tzselect (8). > -.IP * > .B TERMCAP > gives information on how to address a given terminal > (or gives the name of a file containing such information). > .IP * > -.BR COLUMNS " and " LINES > -tell applications about the window size, possibly overriding the actual size. > +.B USER > +The name of the logged-in user (used by some BSD-derived programs). > +Set at login time, see section NOTES below. > .IP * > .BR PRINTER " or " LPDEST > may specify the desired printer to use. Thanks, Michael -- Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/
