From marc@blackend.org  Mon Jun 10 00:55:08 2002
Return-Path: <marc@blackend.org>
Received: from abigail.blackend.org (blackend.org [212.11.50.35])
	by hub.freebsd.org (Postfix) with ESMTP id DFF1137B403
	for <FreeBSD-gnats-submit@freebsd.org>; Mon, 10 Jun 2002 00:55:06 -0700 (PDT)
Received: from abigail.blackend.org (localhost [127.0.0.1])
	by abigail.blackend.org (8.12.3/8.12.3/ - 15/04/02) with ESMTP id g5A7rMAr059850
	for <FreeBSD-gnats-submit@freebsd.org>; Mon, 10 Jun 2002 09:53:22 +0200 (CEST)
	(envelope-from marc@abigail.blackend.org)
Received: (from marc@localhost)
	by abigail.blackend.org (8.12.3/8.12.3/Submit) id g5A7rM4H059849;
	Mon, 10 Jun 2002 09:53:22 +0200 (CEST)
	(envelope-from marc)
Message-Id: <200206100753.g5A7rM4H059849@abigail.blackend.org>
Date: Mon, 10 Jun 2002 09:53:22 +0200 (CEST)
From: Marc Fonvieille <marc@blackend.org>
Reply-To: Marc Fonvieille <marc@blackend.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: Confusing part about setting/viewing environment vars in section 3.7 of the Handbook
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         39089
>Category:       docs
>Synopsis:       Confusing part about setting/viewing environment vars in section 3.7 of the Handbook
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    keramida
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon Jun 10 01:00:07 PDT 2002
>Closed-Date:    Tue Jun 11 17:41:41 PDT 2002
>Last-Modified:  Tue Jun 11 17:41:41 PDT 2002
>Originator:     Marc Fonvieille
>Release:        FreeBSD 4.6-PRERELEASE i386
>Organization:
>Environment:
System: FreeBSD abigail.blackend.org 4.6-PRERELEASE FreeBSD 4.6-PRERELEASE #5: Sun May 12 00:30:43 CEST 2002 marc@abigail.blackend.org:/usr/src/sys/compile/ABIGAIL i386


	
>Description:
Confusing part about setting/viewing environment vars in section 3.7 of
the Handbook. Telling that you can use setenv or export to view
variables is quite confusing for the *newbie* (the use of echo $VARNAME
is described below that part in that section).
Read the patch below and
http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/shells.html
for more details.
	
>How-To-Repeat:
	
>Fix:
Apply the patch to handbook/basics/chapter.sgml
	

--- chapter.sgml.diff begins here ---
--- chapter.sgml.org	Mon Jun 10 09:35:06 2002
+++ chapter.sgml	Mon Jun 10 09:44:51 2002
@@ -1150,13 +1150,13 @@
     </informaltable>
 
     <indexterm><primary>Bourne shells</primary></indexterm>
-    <para>To view or set an environment variable differs somewhat from
+    <para>To set an environment variable differs somewhat from
       shell to shell.  For example, in the C-Style shells such as
       <command>tcsh</command> and <command>csh</command>, you would use
-      <command>setenv</command> to set and view environment variables.
+      <command>setenv</command> to set environment variables.
       Under Bourne shells such as <command>sh</command> and
-      <command>bash</command>, you would use <command>set</command> and
-      <command>export</command> to view and set your current environment
+      <command>bash</command>, you would use
+      <command>export</command> to set your current environment
       variables.  For example, to set or modify the
       <envar>EDITOR</envar> environment variable, under <command>csh</command> or 
       <command>tcsh</command> a
--- chapter.sgml.diff ends here ---


>Release-Note:
>Audit-Trail:

From: Martin Heinen <martin@sumuk.de>
To: Marc Fonvieille <marc@blackend.org>
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: docs/39089: Confusing part about setting/viewing environment vars in section 3.7 of the Handbook
Date: Tue, 11 Jun 2002 08:46:26 +0200

 On Mon, Jun 10, 2002 at 09:53:22AM +0200, Marc Fonvieille wrote:
 > Confusing part about setting/viewing environment vars in section 3.7 of
 > the Handbook. Telling that you can use setenv or export to view
 > variables is quite confusing for the *newbie* (the use of echo $VARNAME
 > is described below that part in that section).
 
 Agreed, using set/setenv to list variables is confusing, but it's
 a useful feature that we should mention.
 
 >      <indexterm><primary>Bourne shells</primary></indexterm>
 > -    <para>To view or set an environment variable differs somewhat from
 > +    <para>To set an environment variable differs somewhat from
 >        shell to shell.  For example, in the C-Style shells such as
 >        <command>tcsh</command> and <command>csh</command>, you would use
 > -      <command>setenv</command> to set and view environment variables.
 > +      <command>setenv</command> to set environment variables.
 >        Under Bourne shells such as <command>sh</command> and
 > -      <command>bash</command>, you would use <command>set</command> and
 > -      <command>export</command> to view and set your current environment
 > +      <command>bash</command>, you would use
 > +      <command>export</command> to set your current environment
 >        variables.  For example, to set or modify the
 >        <envar>EDITOR</envar> environment variable, under <command>csh</command> or 
 >        <command>tcsh</command> a
 
 This omits that you can use setenv/set to list all environment
 variables.  How about adding the following sentence to the end
 of this paragraph:
 
 	To view all current environment environment variables use
 	<command>setenv</command> without any arguments under
 	C-Style shells or <command>set</command> under Bourne shells.
 
 -- 
 Marxpitn
State-Changed-From-To: open->closed 
State-Changed-By: keramida 
State-Changed-When: Tue Jun 11 17:39:16 PDT 2002 
State-Changed-Why:  
The changes have been committed.  Soon they'll be visible on the web 
site too.  Thanks for putting the work in submitting this. 


Responsible-Changed-From-To: freebsd-doc->keramida 
Responsible-Changed-By: keramida 
Responsible-Changed-When: Tue Jun 11 17:39:16 PDT 2002 
Responsible-Changed-Why:  

http://www.freebsd.org/cgi/query-pr.cgi?pr=38975 
State-Changed-From-To: open->closed 
State-Changed-By: keramida 
State-Changed-When: Tue Jun 11 17:39:16 PDT 2002 
State-Changed-Why:  
The changes have been committed.  Soon they'll be visible on the web 
site too.  Thanks for putting the work in submitting this. 


Responsible-Changed-From-To: freebsd-doc->keramida 
Responsible-Changed-By: keramida 
Responsible-Changed-When: Tue Jun 11 17:39:16 PDT 2002 
Responsible-Changed-Why:  

http://www.freebsd.org/cgi/query-pr.cgi?pr=38976 
State-Changed-From-To: open->closed 
State-Changed-By: keramida 
State-Changed-When: Tue Jun 11 17:39:16 PDT 2002 
State-Changed-Why:  
The changes have been committed.  Soon they'll be visible on the web 
site too.  Thanks for putting the work in submitting this. 


Responsible-Changed-From-To: freebsd-doc->keramida 
Responsible-Changed-By: keramida 
Responsible-Changed-When: Tue Jun 11 17:39:16 PDT 2002 
Responsible-Changed-Why:  

http://www.freebsd.org/cgi/query-pr.cgi?pr=39024 
State-Changed-From-To: open->closed 
State-Changed-By: keramida 
State-Changed-When: Tue Jun 11 17:39:16 PDT 2002 
State-Changed-Why:  
The changes have been committed.  Soon they'll be visible on the web 
site too.  Thanks for putting the work in submitting this. 


Responsible-Changed-From-To: freebsd-doc->keramida 
Responsible-Changed-By: keramida 
Responsible-Changed-When: Tue Jun 11 17:39:16 PDT 2002 
Responsible-Changed-Why:  

http://www.freebsd.org/cgi/query-pr.cgi?pr=39064 
State-Changed-From-To: open->closed 
State-Changed-By: keramida 
State-Changed-When: Tue Jun 11 17:39:16 PDT 2002 
State-Changed-Why:  
The changes have been committed.  Soon they'll be visible on the web 
site too.  Thanks for putting the work in submitting this. 


Responsible-Changed-From-To: freebsd-doc->keramida 
Responsible-Changed-By: keramida 
Responsible-Changed-When: Tue Jun 11 17:39:16 PDT 2002 
Responsible-Changed-Why:  

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