Bug 481 - Extend man page with documentation
Summary: Extend man page with documentation
Status: CLOSED FIXED
Alias: None
Product: Portable OpenSSH
Classification: Unclassified
Component: ssh-agent (show other bugs)
Version: -current
Hardware: All All
: P2 enhancement
Assignee: OpenSSH Bugzilla mailing list
URL: http://www.openbsd.org/cgi-bin/man.cg...
Keywords: openbsd, patch
Depends on:
Blocks: 822
  Show dependency treegraph
 
Reported: 2003-01-30 21:27 AEDT by Ralf Hauser
Modified: 2004-09-11 13:18 AEST (History)
0 users

See Also:


Attachments
man.cgi.html patch (1.53 KB, patch)
2003-02-03 18:22 AEDT, Ralf Hauser
no flags Details | Diff
enhanced patch for ssh-agent's man.cgi.html (1.73 KB, patch)
2003-02-19 04:46 AEDT, Ralf Hauser
no flags Details | Diff
Import examples into nroff source. (1.22 KB, patch)
2004-05-12 14:35 AEST, Darren Tucker
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Ralf Hauser 2003-01-30 21:27:23 AEDT
I am normally using tcsh.

From <<If a commandline is given, this is executed as a subprocess of the agent.
     When the command dies, so does the agent.>> I understand that my shell needs
to be a child of ssh-agent.
I tried "ssh-agent -c tcsh" which didn't work. 
An example here would be great.
I understand, that in the bsh it is "eval `ssh-agent -s`"
it would be great to add this as an example for not so shell-experienced persons
like me ;) and the equivalent for *csh*.

Thanks.
Comment 1 Markus Friedl 2003-02-02 00:11:38 AEDT
do you have a patch for the manpage?
Comment 2 Ralf Hauser 2003-02-03 18:22:08 AEDT
Created attachment 216 [details]
man.cgi.html patch

Markus, as per your request. r.
Comment 3 Ralf Hauser 2003-02-19 04:46:49 AEDT
Created attachment 231 [details]
enhanced patch for ssh-agent's man.cgi.html

now covers (corrected) eval statements

and -t passwd as per http://bugzilla.mindrot.org/show_bug.cgi?id=496
Comment 4 Markus Friedl 2003-02-20 00:08:18 AEDT
please don't send patches for the html page, use the
troff source instead.
Comment 5 Ralf Hauser 2003-02-20 00:33:40 AEDT
Sure, where could I easiest get it?
http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/ssh-agent/ wasn't it,
http://www.openbsd.org/cgi-bin/cvsweb/www/openssh/ didn't look like it either,
http://www.openbsd.org/cgi-bin/cvsweb/src/share/man/man1 neither...
Comment 7 Darren Tucker 2004-05-12 14:35:44 AEST
Created attachment 635 [details]
Import examples into nroff source.
Comment 8 Darren Tucker 2004-05-13 16:45:57 AEST
This has been fixed, thanks.  The text now reads:

     There are two main ways to get an agent set up: The first is that the
     agent starts a new subcommand into which some environment variables are
     exported, eg ssh-agent xterm &.  The second is that the agent prints the
     needed shell commands (either sh(1) or csh(1) syntax can be generated)
     which can be evalled in the calling shell, eg eval `ssh-agent -s` for
     Bourne-type shells such as sh(1) or ksh(1) and eval `ssh-agent -c` for
     csh(1) and derivatives.