man: nmcli man page update - added ENVIRONMENT VARIABLES section

This commit is contained in:
Jiří Klimeš 2010-09-09 14:22:34 +02:00
parent 9b2b809aae
commit e8d2942320

View file

@ -22,7 +22,7 @@
.\"
.\" Copyright (C) 2010 Red Hat, Inc.
.\"
.TH NMCLI "1" "26 August 2010"
.TH NMCLI "1" "9 September 2010"
.SH NAME
nmcli \- command-line tool for controlling NetworkManager
@ -312,6 +312,32 @@ No simple reference.
.fi
.RE
.SH ENVIRONMENT VARIABLES
\fInmcli\fP's behavior is affected by the following environment variables.
.IP "LC_ALL" 13
If set to a non-empty string value, override the values of all the other
internationalization variables.
.IP "LC_MESSAGES" 13
Determines the locale to be used for internationalised messages.
.IP "LANG" 13
Provides a default value for the internationalization variables that are unset
or null.
.RE
Notes about localization:
.br
Be aware that \fInmcli\fP is localized and that's why the output depends on
your environment. It's important to realize that especially when you parse the
output.
.br
Call \fInmcli\fP as \fBLC_ALL=C nmcli\fP to be sure the locale is
set to "C" while executing in a script.
\fBLC_ALL\fP, \fBLC_MESSAGES\fP, \fBLANG\fP variables specify the LC_MESSAGES
locale category (in that order), which determines the language that \fInmcli\fP
uses for messages. The "C" locale is used if none of these variables are set,
and this locale uses English messages.
.SH EXIT STATUS
\fInmcli\fP exits with status 0 if it succeeds, a value greater than 0 is returned if errors occur.
.IP "0" 4