man: explain why TZ=: is used

Also, reword the description a bit. "As a string" is meaningless in the context
of commandline arguments, where evyrything is a string. This is not a
strongly-typed programming language where 5 is a number but "5" is something
completely different. Here both 5 and "5" are indistinguishable. The original
text was trying to say that a location name should be given and not a number,
so say "time zone location name".

For #17177.
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2020-09-29 09:30:42 +02:00
parent fa26ff47f7
commit 7fd897c51c
1 changed files with 7 additions and 5 deletions

View File

@ -299,11 +299,13 @@
<varlistentry> <varlistentry>
<term><option>--timezone=</option><replaceable>TIMEZONE</replaceable></term> <term><option>--timezone=</option><replaceable>TIMEZONE</replaceable></term>
<listitem><para>Takes a timezone specification as string that sets the timezone for the specified <listitem><para>Takes a time zone location name that sets the timezone for the specified user. When
user. Expects a `tzdata` location string. When the user logs in the <varname>$TZ</varname> the user logs in the <varname>$TZ</varname> environment variable is initialized from this
environment variable is initialized from this setting. Example: setting. Example: <option>--timezone=Europe/Amsterdam</option> will result in the environment
<option>--timezone=Europe/Amsterdam</option> will result in the environment variable variable <literal>TZ=:Europe/Amsterdam</literal>. (<literal>:</literal> is used intentionally as part
<literal>TZ=:Europe/Amsterdam</literal>.</para></listitem> of the timezone specification, see
<citerefentry><refentrytitle>tzset</refentrytitle><manvolnum>3</manvolnum></citerefentry>.)
</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>