I've been using since before it was popular. Back in the early days, the docs for node were full of references to linux man pages like this. My background was scripting languages and I had never done any C programming so I had no clue what readdir(3) meant. To open a file back then you had to manually bitwise OR the various unix flags together yourself. (Using "r", "w", "a", etc was an addition I made)
Things now are much easier for people without a C background and there are many fewer parts left in the docs that assume knowledge of man pages. That said, I did eventually figure out it was referencing man pages. I was a linux user after all, I had just never used man to lookup C APis. How about we just link to one of the man mirrors in the API docs? I was an experienced linux user and I still didn't know what the docs were talking about, I can only imagine how confused windows users would be. On Thu, Nov 1, 2012 at 11:34 AM, Chad Engler <chad.eng...@patlive.com> wrote: > It wasn’t condescending; “topic(page#)” like “environ(7)” is a very common > way to express man pages, and if you aren’t aware of what the user > environment is you should probably do more research. Had you typed > “environ(7)” into google before getting butthurt at the docs, you probably > would have found out exactly what it was with no help from anyone. There is > no reason to repost the manual page since there is already a manual page for > it, the docs are fine the way they are; you just need to try to look a > little harder, or be grateful when people help. > > > > -Chad > > > > From: nodejs@googlegroups.com [mailto:nodejs@googlegroups.com] On Behalf Of > SL > Sent: Thursday, November 01, 2012 12:16 PM > To: nodejs@googlegroups.com > Subject: Re: [nodejs] Re: process.env - documentation? > > > > Wow, thanks for the condescending and arrogant comment! I'm not suggesting > there should be a 'tutorial' about any of those things you mentioned. > However the docs at the moment are IMO a bit ambiguous about this point - it > just says "An object containing the user environment. See environ(7)." I > didn't realise immediately that this is talking about the OS environment > variables - I'm sure I'm not the only one. > > On 1 November 2012 14:13, Matt <hel...@gmail.com> wrote: > > If the docs covered every aspect of how programming networks, child > processes, systems and filesystems worked they would be huge. > > > > There's a place for tutorials though - but it's not in the core docs IMHO. > If you don't know what an environment variable is then you have some basic > learning to do before diving straight into programming. > > > > On Wed, Oct 31, 2012 at 7:28 PM, SL <bgs...@gmail.com> wrote: > > Or we could make the docs a bit clearer... > > > > On 31 October 2012 18:46, Jorge <jorge%jorgechamorro....@gtempaccount.com> > wrote: > > On 31 oct, 17:26, Scott Elcomb <pse...@gmail.com> wrote: >> On Wed, Oct 31, 2012 at 10:59 AM, Jorge >> > >> <jorge%jorgechamorro....@gtempaccount.com> wrote: >> > On Oct 31, 2:04 pm, Bgsosh <bgs...@gmail.com> wrote: >> >> Hi, I'm tring to understand the structure of the process.env object, >> >> but >> >> the online docs just say 'An object containing the user environment. >> >> See >> >> environ(7).' >> >> >> I can't find 'environ(7)' (whatever that is!). Is this documented >> >> somewhere? >> >> > Type this in the terminal: >> >> > $ man 7 environ >> >> That'd be tricky for Windows users to do if they're not running a >> *nix-like shell. (Cygwin comes to mind) >> >> I'd imagine the best bet for Windows users would be to search for "man >> 7 environ" on the web to find a copy of the relevant man page; there >> are a number of mirrors like the one Adam suggested. >> >> (BTW, for those not familiar with man pages, see also >> <http://en.wikipedia.org/wiki/Man_page>) > > Perhaps Windowzs users should better search for "environment > variables" @ msdn or something, I guess, yeah. > -- > Jorge. > > > -- > Job Board: http://jobs.nodejs.org/ > Posting guidelines: > https://github.com/joyent/node/wiki/Mailing-List-Posting-Guidelines > You received this message because you are subscribed to the Google > Groups "nodejs" group. > To post to this group, send email to nodejs@googlegroups.com > To unsubscribe from this group, send email to > nodejs+unsubscr...@googlegroups.com > For more options, visit this group at > http://groups.google.com/group/nodejs?hl=en?hl=en > > > > -- > Job Board: http://jobs.nodejs.org/ > Posting guidelines: > https://github.com/joyent/node/wiki/Mailing-List-Posting-Guidelines > You received this message because you are subscribed to the Google > Groups "nodejs" group. > To post to this group, send email to nodejs@googlegroups.com > To unsubscribe from this group, send email to > nodejs+unsubscr...@googlegroups.com > For more options, visit this group at > http://groups.google.com/group/nodejs?hl=en?hl=en > > > > -- > Job Board: http://jobs.nodejs.org/ > Posting guidelines: > https://github.com/joyent/node/wiki/Mailing-List-Posting-Guidelines > You received this message because you are subscribed to the Google > Groups "nodejs" group. > To post to this group, send email to nodejs@googlegroups.com > To unsubscribe from this group, send email to > nodejs+unsubscr...@googlegroups.com > For more options, visit this group at > http://groups.google.com/group/nodejs?hl=en?hl=en > > > > -- > Job Board: http://jobs.nodejs.org/ > Posting guidelines: > https://github.com/joyent/node/wiki/Mailing-List-Posting-Guidelines > You received this message because you are subscribed to the Google > Groups "nodejs" group. > To post to this group, send email to nodejs@googlegroups.com > To unsubscribe from this group, send email to > nodejs+unsubscr...@googlegroups.com > For more options, visit this group at > http://groups.google.com/group/nodejs?hl=en?hl=en > > -- > Job Board: http://jobs.nodejs.org/ > Posting guidelines: > https://github.com/joyent/node/wiki/Mailing-List-Posting-Guidelines > You received this message because you are subscribed to the Google > Groups "nodejs" group. > To post to this group, send email to nodejs@googlegroups.com > To unsubscribe from this group, send email to > nodejs+unsubscr...@googlegroups.com > For more options, visit this group at > http://groups.google.com/group/nodejs?hl=en?hl=en -- Job Board: http://jobs.nodejs.org/ Posting guidelines: https://github.com/joyent/node/wiki/Mailing-List-Posting-Guidelines You received this message because you are subscribed to the Google Groups "nodejs" group. To post to this group, send email to nodejs@googlegroups.com To unsubscribe from this group, send email to nodejs+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/nodejs?hl=en?hl=en
