Ted Unangst <t...@tedunangst.com> wrote: > Ingo Schwarze wrote: > > Congrats, you found a documentation bug. > > > > Apparently, the rdate(8) program supports the TZ environment variable, > > but the manual page does not say so. An ENVIRONMENT section is missing > > and should be added. It is not a good idea to give EXAMPLES for stuff > > that is accidentally undocumented. > > fix below. > > > > So an alternative proposal: Should this weird EXAMPLES section be deleted? > > > > Even though i occasionally took the time to actually visit Brauschweig > > during the last few years, i agree with deleting the example. If all > > ok, that's two thumbs down. it's dead. > > Index: rdate.8 > =================================================================== > RCS file: /cvs/src/usr.sbin/rdate/rdate.8,v > retrieving revision 1.37 > diff -u -p -r1.37 rdate.8 > --- rdate.8 10 Feb 2015 13:10:27 -0000 1.37 > +++ rdate.8 6 Jan 2019 04:14:24 -0000 > @@ -87,24 +87,28 @@ Do not print the time. > Verbose output. > Always show the adjustment. > .El > +.Sh ENVIRONMENT > +.Bl -tag -width Ds > +.It Ev TZ > +The time zone to use when displaying dates. > +It is normally specified as a pathname relative to > +.Pa /usr/share/zoneinfo , > +though see > +.Xr tzset 3 > +for more information. > +If this variable is not set, the time zone is determined based on > +.Pa /etc/localtime , > +which the administrator adjusts using > +the > +.Fl l > +option of > +.Xr zic 8 . > +.El
Oh good grief, don't do that. Unless you are going to add the same text to every man page in usr.sbin on the following list. ac bgpd dhcpd httpd ldapd mrouted npppctl nsd ntpd radiusd rdate relayd slaacctl smtpd syslogd tcpdump unbound They all call strftime. So TZ affects them. There are other API that get involved. You could be adding this text to 400 manual pages. But now you've seen my previous mail arguing against this practice. It is pointless to document "system behaviour" in every program. Wait until you see my diff that documents PATH in every program that calls execve() or system, or HOME in every program that... you get the idea!!!! > .Sh FILES > .Bl -tag -width /var/log/wtmp -compact > .It Pa /var/log/wtmp > record of date resets and time changes > .El > -.Sh EXAMPLES > -To get the legal time in Germany, set the > -.Pa /etc/localtime > -symlink to > -.Pa /usr/share/zoneinfo/right/Europe/Berlin > -and issue the following command: > -.Pp > -.D1 Li "# rdate -v ptbtime1.ptb.de" > -.Pp > -The command of course assumes you have a working internet connection > -and DNS set up to connect to the server at > -.Sy Physikalisch-Technische Bundesanstalt > -in Braunschweig, Germany. > .Sh SEE ALSO > .Xr date 1 , > .Xr adjtime 2 , Yes to this.
