docs/42762: ppp.8 has no description of $env and ~user expansion in ppp.conf

[Peter Pentchev]

The following reply was made to PR docs/42762; it has been noted by GNATS.

From: Peter Pentchev <roam at ringlet.net>
To: AIDA Shinra <aida-s at jcom.home.ne.jp>
Cc: bug-followup at FreeBSD.org, Brian Somers <brian at FreeBSD.org>
Subject: Re: docs/42762: ppp.8 has no description of $env and ~user expansion in ppp.conf
Date: Fri, 5 Nov 2004 19:35:07 +0200

 On Sat, Sep 14, 2002 at 11:10:55AM +0900, AIDA Shinra wrote:
 > 
 > >Number:         42762
 > >Category:       docs
 > >Synopsis:       ppp.8 has no description of $env and ~user expansion in ppp.conf
 [snip]
 > >Description:
 > ppp expands $env to corresponding environment variables, and ~user to their
 > home directory name reading any command lines in ppp.conf. However, ppp.8
 > doesn't explain this at all.
 > 
 > Without description of this feature, some trouble happens. For example,
 >  authkey pa$ssword
 > is transformed info ' authkey pa'(if $ssword is undefined), and authentication
 > 'mysteriously' fails.
 > 
 > >How-To-Repeat:
 > >Fix:
 > Add proper description of '$', '~', and '/'.
 
 Sorry about the long delay; what do you think about the following
 patch, which documents the '$' and '~' characters?  Does the '/'
 character have any special meaning?
 
 Index: src/usr.sbin/ppp/ppp.8.m4
 ===================================================================
 RCS file: /home/ncvs/src/usr.sbin/ppp/ppp.8.m4,v
 retrieving revision 1.312
 diff -u -r1.312 ppp.8.m4
 --- src/usr.sbin/ppp/ppp.8.m4	29 Jul 2004 05:59:43 -0000	1.312
 +++ src/usr.sbin/ppp/ppp.8.m4	5 Nov 2004 17:27:37 -0000
 @@ -812,6 +812,23 @@
  .Pq Dq \&: .
  .It
  A command line must contain a space or tab in the first column.
 +.It
 +A string starting with the
 +.Dq $
 +character is substituted with the value of the environment variable by
 +the same name.
 +Likewise, a string starting with the
 +.Dq ~
 +character is substituted with the full path to the home directory of
 +the user account by the same name.
 +If you want to include a literal
 +.Dq $
 +or
 +.Dq ~
 +character in a command or argument, enclose them in double quotes, e.g.
 +.Bd -literal -offset indent
 +set password "pa$ss~word"
 +.Ed
  .El
  .Pp
  The
 
 G'luck,
 Peter
 
 -- 
 Peter Pentchev	roam at ringlet.net    roam at cnsys.bg    roam at FreeBSD.org
 PGP key:	http://people.FreeBSD.org/~roam/roam.key.asc
 Key fingerprint	FDBA FD79 C26F 3C51 C95E  DF9E ED18 B68D 1619 4553
 This inert sentence is my body, but my soul is alive, dancing in the sparks of your brain.