If you mean
that all the ns_sock* commands are to be documented under one ns_sock.n man
page, I have to disagree. It breaks the unix standard of one command per man
page. I wouldn't know to look in ns_sock.n for ns_sockopen; the user should not
need to know what file a command is defined in so they can look up the
command. And when I want to see how ns_sockopen works, I don't want
ns_socklisten and the others on the same page. I'd rather have the other related
commands be in the "See Also" section.
I believe
strongly that we should have one man page per API call, and not one man page per
file name.
/s.
-----Original Message-----To clarify, please sign up by file name instead of by API name. A number of the man pages contain multiple API's - example: $TOP/aolserver/doc/ns_sock.n. Also, please make sure you are working from the aolserver_v35_bp branch. We need to get the docs completed for 3.5, then we will tackle 4.0.
From: AOLserver Discussion [mailto:[EMAIL PROTECTED]] On Behalf Of Nathan Folkman
Sent: Saturday, November 02, 2002 9:03 PM
To: [EMAIL PROTECTED]
Subject: [AOLSERVER] Sign Up for AOLserver Documentation!
To find out what still needs to be documented:
1. Check out the 3.5 code: cvs co -raolserver_v35_bp aolserver
2. Take a look in $TOP/aolserver/doc for man page files
3. Check the "Tasks" area on SourceForge to see what's already been taken
4. Add a new task for the man page file, or send email to [EMAIL PROTECTED] or [EMAIL PROTECTED] with the name of the file and we'll add it for you
Let me know if there are any questions. Thanks!
- n
