From: Xue Fuqiao Date: Mon, 11 Nov 2013 22:52:08 +0000 (+0800) Subject: Doc fixes. X-Git-Url: http://git.hcoop.net/bpt/emacs.git/commitdiff_plain/7d3bb5692e56a7e0785cfbe36e3ecdb92aa32505 Doc fixes. * doc/lispref/os.texi (User Identification, Time of Day, Time Conversion): Minor fixes. --- diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 504a6d5583..7c4fb4e9c6 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,3 +1,8 @@ +2013-11-11 Xue Fuqiao + + * os.texi (User Identification, Time of Day, Time Conversion): + Minor fixes. + 2013-11-10 Jan Djärv * keymaps.texi (Tool Bar): Mention that Gtk+/NS ignores item 1 to 3. diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index ae1d2f4d0e..9b10a437b1 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi @@ -552,8 +552,8 @@ sole argument. In some cases, the option is followed in the command line by an argument. In these cases, the @var{handler-function} can find all the remaining command-line arguments in the variable -@code{command-line-args-left}. (The entire list of command-line -arguments is in @code{command-line-args}.) +@code{command-line-args-left} (see below). (The entire list of +command-line arguments is in @code{command-line-args}.) The command-line arguments are parsed by the @code{command-line-1} function in the @file{startup.el} file. See also @ref{Emacs @@ -961,6 +961,7 @@ to access the value of @var{variable}. If @var{value} is omitted or removes @var{variable} from the environment. Otherwise, @var{value} should be a string. +@c FIXME: Document `substitute-env-vars'? --xfq If the optional argument @var{substitute} is non-@code{nil}, Emacs calls the function @code{substitute-env-vars} to expand any environment variables in @var{value}. @@ -1097,9 +1098,9 @@ originally logged in. The value reflects command-line options such as Lisp packages that load files of customizations, or any other sort of user profile, should obey this variable in deciding where to find it. They should load the profile of the user name found in this variable. -If @code{init-file-user} is @code{nil}, meaning that the @samp{-q} -option was used, then Lisp packages should not load any customization -files or user profile. +If @code{init-file-user} is @code{nil}, meaning that the @samp{-q}, +@samp{-Q}, or @samp{-batch} option was used, then Lisp packages should +not load any customization files or user profile. @end defvar @defopt user-mail-address @@ -1149,6 +1150,7 @@ you to ``fake out'' Emacs by telling the functions what to return. The variables are also useful for constructing frame titles (@pxref{Frame Titles}). +@cindex UID @defun user-real-uid This function returns the real @acronym{UID} of the user. The value may be a floating point number, in the (unlikely) event that @@ -1160,6 +1162,7 @@ This function returns the effective @acronym{UID} of the user. The value may be a floating point number. @end defun +@cindex GID @defun group-gid This function returns the effective @acronym{GID} of the Emacs process. The value may be a floating point number. @@ -1219,9 +1222,9 @@ file-attributes}). In function arguments, e.g., the @var{time-value} argument to @code{current-time-string}, two-, three-, and four-integer lists are accepted. You can convert times from the list representation into standard human-readable strings using -@code{current-time}, or to other forms using the @code{decode-time} -and @code{format-time-string} functions documented in the following -sections. +@code{current-time-string}, or to other forms using the +@code{decode-time} and @code{format-time-string} functions documented +in the following sections. @defun current-time-string &optional time-value This function returns the current time and date as a human-readable @@ -1265,6 +1268,7 @@ exact. Do not use this function if precise time stamps are required. @end defun @defun current-time-zone &optional time-value +@cindex time zone, current This function returns a list describing the time zone that the user is in. @@ -1291,6 +1295,7 @@ time zone. @node Time Conversion @section Time Conversion +@cindex calendrical information These functions convert time values (lists of two to four integers, as explained in the previous section) into calendrical information and