Bug 39089

Summary: Confusing part about setting/viewing environment vars in section 3.7 of the Handbook
Product: Documentation Reporter: Marc Fonvieille <marc>
Component: Books & ArticlesAssignee: Giorgos Keramidas <keramida>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
chapter.sgml.diff none

Description Marc Fonvieille 2002-06-10 09:00:07 UTC
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.

Fix: Apply the patch to handbook/basics/chapter.sgml
Comment 1 Martin Heinen 2002-06-11 07:46:26 UTC
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
Comment 2 Giorgos Keramidas freebsd_committer freebsd_triage 2002-06-12 01:39:16 UTC
State Changed
From-To: open->closed

The changes have been committed.  Soon they'll be visible on the web 
site too.  Thanks for putting the work in submitting this. 


Comment 3 Giorgos Keramidas freebsd_committer freebsd_triage 2002-06-12 01:39:16 UTC
Responsible Changed
From-To: freebsd-doc->keramida
Comment 4 Giorgos Keramidas freebsd_committer freebsd_triage 2002-06-12 01:39:16 UTC
State Changed
From-To: open->closed

The changes have been committed.  Soon they'll be visible on the web 
site too.  Thanks for putting the work in submitting this. 


Comment 5 Giorgos Keramidas freebsd_committer freebsd_triage 2002-06-12 01:39:16 UTC
Responsible Changed
From-To: freebsd-doc->keramida
Comment 6 Giorgos Keramidas freebsd_committer freebsd_triage 2002-06-12 01:39:16 UTC
State Changed
From-To: open->closed

The changes have been committed.  Soon they'll be visible on the web 
site too.  Thanks for putting the work in submitting this. 


Comment 7 Giorgos Keramidas freebsd_committer freebsd_triage 2002-06-12 01:39:16 UTC
Responsible Changed
From-To: freebsd-doc->keramida
Comment 8 Giorgos Keramidas freebsd_committer freebsd_triage 2002-06-12 01:39:16 UTC
State Changed
From-To: open->closed

The changes have been committed.  Soon they'll be visible on the web 
site too.  Thanks for putting the work in submitting this. 


Comment 9 Giorgos Keramidas freebsd_committer freebsd_triage 2002-06-12 01:39:16 UTC
Responsible Changed
From-To: freebsd-doc->keramida
Comment 10 Giorgos Keramidas freebsd_committer freebsd_triage 2002-06-12 01:39:16 UTC
State Changed
From-To: open->closed

The changes have been committed.  Soon they'll be visible on the web 
site too.  Thanks for putting the work in submitting this. 


Comment 11 Giorgos Keramidas freebsd_committer freebsd_triage 2002-06-12 01:39:16 UTC
Responsible Changed
From-To: freebsd-doc->keramida