From shinra@ntthkid09083.ppp.infoweb.ne.jp  Fri Sep 13 19:11:01 2002
Return-Path: <shinra@ntthkid09083.ppp.infoweb.ne.jp>
Received: from mx1.FreeBSD.org (mx1.FreeBSD.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 7439837B400
	for <FreeBSD-gnats-submit@freebsd.org>; Fri, 13 Sep 2002 19:11:01 -0700 (PDT)
Received: from ntthkid09083.ppp.infoweb.ne.jp (ntthkid09083.ppp.infoweb.ne.jp [61.121.47.83])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 40B9643E65
	for <FreeBSD-gnats-submit@freebsd.org>; Fri, 13 Sep 2002 19:11:00 -0700 (PDT)
	(envelope-from shinra@ntthkid09083.ppp.infoweb.ne.jp)
Received: from ntthkid09083.ppp.infoweb.ne.jp (localhost [127.0.0.1])
	by ntthkid09083.ppp.infoweb.ne.jp (8.12.6/8.12.6) with ESMTP id g8E2AuhT045705;
	Sat, 14 Sep 2002 11:10:56 +0900 (JST)
	(envelope-from shinra@ntthkid09083.ppp.infoweb.ne.jp)
Received: (from shinra@localhost)
	by ntthkid09083.ppp.infoweb.ne.jp (8.12.6/8.12.6/Submit) id g8E2AtLd045704;
	Sat, 14 Sep 2002 11:10:55 +0900 (JST)
Message-Id: <200209140210.g8E2AtLd045704@ntthkid09083.ppp.infoweb.ne.jp>
Date: Sat, 14 Sep 2002 11:10:55 +0900 (JST)
From: AIDA Shinra <aida-s@jcom.home.ne.jp>
Reply-To: AIDA Shinra <aida-s@jcom.home.ne.jp>
To: FreeBSD-gnats-submit@freebsd.org
Cc: AIDA Shinra <aida-s@jcom.home.ne.jp>
Subject: ppp.8 has no description of $env and ~user expansion in ppp.conf
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         42762
>Category:       docs
>Synopsis:       ppp.8 has no description of $env and ~user expansion in ppp.conf
>Confidential:   no
>Severity:       serious
>Priority:       medium
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri Sep 13 19:20:01 PDT 2002
>Closed-Date:    Tue Feb 22 13:30:55 GMT 2005
>Last-Modified:  Tue Feb 22 13:30:55 GMT 2005
>Originator:     AIDA Shinra
>Release:        FreeBSD 4.7-PRERELEASE i386
>Organization:
>Environment:
System: FreeBSD e-note 4.7-PRERELEASE FreeBSD 4.7-PRERELEASE #9: Mon Sep 9 22:30:05 JST 2002 shinra@e-note:/usr/obj/usr/freebsd/src/sys/LOCAL i386


>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 '/'.
>Release-Note:
>Audit-Trail:

From: Peter Pentchev <roam@ringlet.net>
To: AIDA Shinra <aida-s@jcom.home.ne.jp>
Cc: bug-followup@FreeBSD.org, Brian Somers <brian@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@ringlet.net    roam@cnsys.bg    roam@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.
State-Changed-From-To: open->feedback 
State-Changed-By: roam 
State-Changed-When: Fri Nov 5 18:42:58 GMT 2004 
State-Changed-Why:  
Awaiting feedback from the originator on the proposed correction to 
the manual page. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=42762 

From: Brian Somers <brian@FreeBSD.org>
To: Peter Pentchev <roam@ringlet.net>
Cc: AIDA Shinra <aida-s@jcom.home.ne.jp>, bug-followup@FreeBSD.org
Subject: Re: docs/42762: ppp.8 has no description of $env and ~user
 expansion in ppp.conf
Date: Thu, 16 Dec 2004 15:50:56 +0000

 Oops, lost in my inbox :(  Sorry.
 
 I guess there are three things to be described here.
 
 $var - as described
 ~ - as described
 ~user - the home directory of ``user''.
 
 Please feel free to commit when you can - after adding the last bit...
 
 Cheers.
 
 On Fri, 5 Nov 2004 19:35:07 +0200, Peter Pentchev <roam@ringlet.net> wrote:
 > 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@ringlet.net    roam@cnsys.bg    roam@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.
 > 
 
 
 -- 
 Brian <brian@Awfulhak.org>                        <brian@[uk.]FreeBSD.org>
       <http://www.Awfulhak.org>                   <brian@[uk.]OpenBSD.org>
 Don't _EVER_ lose your sense of humour !

From: Peter Pentchev <roam@ringlet.net>
To: Brian Somers <brian@FreeBSD.org>
Cc: AIDA Shinra <aida-s@jcom.home.ne.jp>, bug-followup@FreeBSD.org
Subject: Re: docs/42762: ppp.8 has no description of $env and ~user expansion in ppp.conf
Date: Thu, 16 Dec 2004 18:59:56 +0200

 On Thu, Dec 16, 2004 at 03:50:56PM +0000, Brian Somers wrote:
 > Oops, lost in my inbox :(  Sorry.
 > 
 > I guess there are three things to be described here.
 > 
 > $var - as described
 > ~ - as described
 > ~user - the home directory of ``user''.
 > 
 > Please feel free to commit when you can - after adding the last bit...
 
 Thanks, I just committed a slightly reworded version which also describes
 the special meaning of ~ (it was ~ that was missed, not ~user).
 
 G'luck,
 Peter
 
 -- 
 Peter Pentchev	roam@ringlet.net    roam@cnsys.bg    roam@FreeBSD.org
 PGP key:	http://people.FreeBSD.org/~roam/roam.key.asc
 Key fingerprint	FDBA FD79 C26F 3C51 C95E  DF9E ED18 B68D 1619 4553
 Thit sentence is not self-referential because "thit" is not a word.
State-Changed-From-To: feedback->patched 
State-Changed-By: roam 
State-Changed-When: Thu Dec 16 17:00:53 GMT 2004 
State-Changed-Why:  
A fix was committed to -CURRENT, I will MFC it in two weeks. 
Thanks for the problem report! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=42762 
State-Changed-From-To: patched->closed 
State-Changed-By: keramida 
State-Changed-When: Tue Feb 22 13:30:26 GMT 2005 
State-Changed-Why:  
The change seems to have already found its way to RELENG_5. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=42762 
>Unformatted:
