home-etc: doc/home_etc_expand_tilde.3, doc/home_etc_path.3 - docum...

[siefca]

Author: siefca                       Date: Wed May 17 14:41:22 2006 GMT
Module: home-etc                      Tag: HEAD
---- Log message:
- documentation updated

---- Files affected:
home-etc/doc:
   home_etc_expand_tilde.3 (1.1 -> 1.2) , home_etc_path.3 (1.7 -> 1.8) 

---- Diffs:

================================================================
Index: home-etc/doc/home_etc_expand_tilde.3
diff -u home-etc/doc/home_etc_expand_tilde.3:1.1 home-etc/doc/home_etc_expand_tilde.3:1.2
--- home-etc/doc/home_etc_expand_tilde.3:1.1	Wed May 17 11:13:00 2006
+++ home-etc/doc/home_etc_expand_tilde.3	Wed May 17 16:41:17 2006
@@ -8,7 +8,7 @@
 .\" Free Documentation License"; if it's not, contact Free Software Foundation, Inc.
 .\" 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA to obtain one.
 .\"
-.TH home_etc_reset "3" "PLD Linux/GNU" "December 2003" "HOME-ETC"
+.TH home_etc_reset "3" "PLD Linux/GNU" "May 2006" "HOME-ETC"
 .SH NAME
 home_etc_expand_tilde \- toggle tilde-slash pair parsing
 .SH SYNOPSIS
@@ -26,7 +26,9 @@
 It takes one argument, which should be set to 0 to disable and to non-zero to
 enable parsing of a leading \fI~/\fP string found in path. When parsing
 is enabled, the path is expanded by replacing \fI~/\fP by user's home directory
-pathname while invoking internal routines.
+pathname while invoking internal routines. Additionally, the \fI~\fP character
+is also translated into user's home directory name, but only if the whole parsed
+path contains only that one character.
 
 The way to obtain user's home directory depends on method choosen while
 invoking \fBhome_etc_path(3)\fP (see \fIuse_env\fP description in the

================================================================
Index: home-etc/doc/home_etc_path.3
diff -u home-etc/doc/home_etc_path.3:1.7 home-etc/doc/home_etc_path.3:1.8
--- home-etc/doc/home_etc_path.3:1.7	Wed May 17 03:50:04 2006
+++ home-etc/doc/home_etc_path.3	Wed May 17 16:41:17 2006
@@ -34,6 +34,8 @@
 tilde-slash pair parsing, the function treats \fI~/\fP as if it
 was user's home directory path (in fact it internally replaces it first
 and then goes to re-parse it, to make sure that the home directory is ok).
+Additionally, the \fI~\fP character is also translated into user's home
+directory name, but only if the whole parsed path contains only that one character.
 
 Substitution is made for the found string of the user's home directory,
 which is searched in the pathname. The home-dir part of the string
@@ -42,7 +44,7 @@
 The use_env is simply passed to the \fBget_home_etc_static(3)\fP.
     
 The function iterates using \fBchdir(2)\fP and \fBgetcwd(3)\fP to canonize parts
-of pathnames.
+of the given pathname.
     
 \fB_HE\fP is a wrapper for this function, which never returns NULL, since NULL
 wasn't given as an argument. It calls \fBhome_etc_path(3)\fP and in case
================================================================

---- CVS-web:
    http://cvs.pld-linux.org/home-etc/doc/home_etc_expand_tilde.3?r1=1.1&r2=1.2&f=u
    http://cvs.pld-linux.org/home-etc/doc/home_etc_path.3?r1=1.7&r2=1.8&f=u