doc: improve node.1 manual page

[Fishrock123]

Pull Request check-list

Please make sure to review and check all of these items:

• make lint (ccplint)
• Is the commit message formatted according to CONTRIBUTING.md?

Affected core subsystem(s)

doc,src

Description of change

Edited the man page to use better troff formatting and cover some previously missing options.

Also removed the v8 options from the man page. They really bloat the man page, and don't even belong there. Use --v8-options to see them.

[Fishrock123]

Maybe I should get a better link?

[Fishrock123]

Imo it would be ideal if on on unix systems node -h would open the man page. Not sure if we want that or how to do that yet.

[Fishrock123]

@indutny How much of this should we list here? I'm not really sure how the debug options work. :/

[trevnorris]

Each one is different. And even debug has multiple options:

$ node debug
Usage: node debug script.js
       node debug <host>:<port>
       node debug -p <pid>

[trevnorris]

overall nice changes. though i'm not sure about removal of the v8 flags. only b/c they have "always" been there. but also not sure how many would care if they left.

[trevnorris]

In the man output, first line is showing up like so:

Node.js  is  a  set  of  libraries  for  JavaScript

Notice there are double spaces between several of those words.

[Fishrock123]

@trevnorris blame troff -- it likes to justify the content. Probably some option for man to configure it.

[trevnorris]

This is also missing the debugger environment variables list. e.g.

$ NODE_DEBUG=net node -e 'require("net").createServer((c) => c.end("bye\n")).listen(8080)'
NET 19373: listen2 null 8080 4 false undefined
NET 19373: _listen2: create a handle
NET 19373: bind to ::

[trevnorris]

@Fishrock123

blame troff -- it likes to justify the content. Probably some option for man to configure it.

Yup. Must be it. Resizing terminal gives different results.

[jasnell]

Generally LGTM

[benjamingr]

I'm +1 on removing the v8 flags there, it's just one more place to synchronize them in and it already shows how to print them. LGTM.

[Fishrock123]

Updated. Should be about good to land. I've left out anything debug related for now.

@benjamingr, @jasnell, @trevnorris ptal

[Fishrock123]

maybe cc @nodejs/documentation ? Although I think this is almost a bit out of the regular documentation domain.

[Fishrock123]

@jasnell Also this intentionally ignores --security-revert=, I figure the people who actually need that will know about it.

[jasnell]

+1 ... Yeah --security-revert is not something we want to encourage too
many people to be using so leaving it undocumented is a good thing.
On Mar 15, 2016 7:25 AM, "Jeremiah Senkpiel" [email protected]
wrote:

@jasnell https://github.com/jasnell Also this intentionally ignores
--security-revert=, I figure the people who actually need that will know
about it.

—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub:
#5497 (comment)

[Fishrock123]

Anyone else able to review the updated version of this?

[benjamingr]

Sorry, I read this yesterday and forgot to LGTM. LGTM.

[Fishrock123]

Rebased to add --zero-fill-buffers from 85ab4a5

[Fishrock123]

Landed in 3bca5d3

[benjamingr]

Nice Work 👏

[Fishrock123]

Actually landed at f9e6191 because I screwed something up

[MylesBorins]

@Fishrock123 is this applicable to LTS?

[jasnell]

hmm.. I can't imagine this breaking anyone but let's hold off on porting to v4 for now.

[Fishrock123]

This should land in LTS but you'll probably need to update to make sure no new options get accidentally added with it.

I can do that if needed.

[jasnell]

oh.. heh, yeah, this one is good for LTS. For some reason I was thinking this was the other change you're looking at in terms of having --help output the man page.

[MylesBorins]

@Fishrock123 probably best for you to port it.