Browse Source

Fix doc again

v0.7.4-release
Ryan Dahl 15 years ago
parent
commit
54f02345b5
  1. 2
      Makefile
  2. 30
      doc/api.markdown
  3. 9
      doc/api_header.html
  4. 28
      doc/manpage.xsl

2
Makefile

@ -44,7 +44,7 @@ benchmark: all
doc: doc/node.1 doc/api.html doc/index.html doc/changelog.html doc: doc/node.1 doc/api.html doc/index.html doc/changelog.html
## HACK to give the ronn-generated page a TOC ## HACK to give the ronn-generated page a TOC
doc/api.html: doc/api.markdown doc/api.html: doc/api.markdown doc/api_header.html doc/api_footer.html
ronn -f --html doc/api.markdown \ ronn -f --html doc/api.markdown \
| sed "s/<h2>\(.*\)<\/h2>/<h2 id=\"\1\">\1<\/h2>/g" \ | sed "s/<h2>\(.*\)<\/h2>/<h2 id=\"\1\">\1<\/h2>/g" \
| cat doc/api_header.html - doc/api_footer.html > doc/api.html | cat doc/api_header.html - doc/api_footer.html > doc/api.html

30
doc/api.markdown

@ -91,7 +91,7 @@ Use `process.mixin()` to include modules into the global namespace.
puts('The area of a circle of radius 4 is ' + area(4)); puts('The area of a circle of radius 4 is ' + area(4));
## String Encodings and Buffers ## Buffers
Pure Javascript is Unicode friendly but not nice to pure binary data. When Pure Javascript is Unicode friendly but not nice to pure binary data. When
dealing with TCP streams or the file system, it's necessary to handle octet dealing with TCP streams or the file system, it's necessary to handle octet
@ -381,7 +381,7 @@ your program's flow. Especially for server programs that are designed to
stay running forever, `uncaughtException` can be a useful safety mechanism. stay running forever, `uncaughtException` can be a useful safety mechanism.
### Signal Events: 'SIGINT' ### Signal Events
`function () {}` `function () {}`
@ -849,7 +849,7 @@ Example:
grep = spawn('grep', ['ssh']); grep = spawn('grep', ['ssh']);
sys.puts('Spawned child pid: ' + grep.pid); sys.puts('Spawned child pid: ' + grep.pid);
grep.stdin.close(); grep.stdin.end();
### child.stdin.write(data, encoding) ### child.stdin.write(data, encoding)
@ -877,7 +877,7 @@ Example: A very elaborate way to run 'ps ax | grep ssh'
if (code !== 0) { if (code !== 0) {
sys.puts('ps process exited with code ' + code); sys.puts('ps process exited with code ' + code);
} }
grep.stdin.close(); grep.stdin.end();
}); });
grep.stdout.addListener('data', function (data) { grep.stdout.addListener('data', function (data) {
@ -895,7 +895,7 @@ Example: A very elaborate way to run 'ps ax | grep ssh'
}); });
### child.stdin.close() ### child.stdin.end()
Closes the child process's `stdin` stream. This often causes the child process to terminate. Closes the child process's `stdin` stream. This often causes the child process to terminate.
@ -909,7 +909,7 @@ Example:
sys.puts('child process exited with code ' + code); sys.puts('child process exited with code ' + code);
}); });
grep.stdin.close(); grep.stdin.end();
### child_process.exec(command, callback) ### child_process.exec(command, callback)
@ -1359,6 +1359,8 @@ Begin accepting connections on the specified port and hostname. If the
hostname is omitted, the server will accept connections directed to any hostname is omitted, the server will accept connections directed to any
address. address.
To listen to a unix socket, supply a filename instead of port and hostname.
This function is asynchronous. `listening` will be emitted when the server This function is asynchronous. `listening` will be emitted when the server
is ready to accept connections. is ready to accept connections.
@ -1698,7 +1700,7 @@ A reference to the `http.Client` that this response belongs to.
## net.Server ## net.Server
This class can be used to create a TCP or UNIX server. This class is used to create a TCP or UNIX server.
Here is an example of a echo server which listens for connections Here is an example of a echo server which listens for connections
on port 7000: on port 7000:
@ -1719,6 +1721,11 @@ on port 7000:
}); });
server.listen(7000, 'localhost'); server.listen(7000, 'localhost');
To listen on the socket `'/tmp/echo.sock'`, the last line would just be
changed to
server.listen('/tmp/echo.sock');
This is an EventEmitter with the following events: This is an EventEmitter with the following events:
### Event: 'listening' ### Event: 'listening'
@ -1737,11 +1744,10 @@ Emitted when a new connection is made. `stream` is an instance of
### Event: 'close' ### Event: 'close'
`function (errno) {}` `function () {}`
Emitted when the server closes.
Emitted when the server closes. `errorno` is an integer which indicates
what, if any, error caused the server to close. If no error occurred
`errorno` will be 0.
### net.createServer(connectionListener) ### net.createServer(connectionListener)
@ -2244,7 +2250,7 @@ The library is called `/repl.js` and it can be used like this:
net.createServer(function (c) { net.createServer(function (c) {
sys.error('Connection!'); sys.error('Connection!');
nconnections += 1; nconnections += 1;
c.close(); c.end();
}).listen(5000); }).listen(5000);
repl.start('simple tcp server> '); repl.start('simple tcp server> ');

9
doc/api_header.html

@ -53,10 +53,11 @@
#man { #man {
width: 50%; width: 50%;
margin: 0 0 0 22em; margin: 0 0 0 17em;
} }
#toc { #toc {
font-family:consolas,monospace;
position: fixed; position: fixed;
left: 0; left: 0;
top: 0; top: 0;
@ -65,10 +66,16 @@
border-right: 1px solid #ccc; border-right: 1px solid #ccc;
overflow: auto; overflow: auto;
} }
#toc #toctitle { #toc #toctitle {
background: #eee; background: #eee;
padding: 1em; padding: 1em;
} }
#toc a {
text-decoration: none;
}
#toc ul { #toc ul {
list-style: none; list-style: none;
margin: 0; margin: 0;

28
doc/manpage.xsl

@ -1,28 +0,0 @@
<!--
Generates single roff manpage document from DocBook XML source using DocBook
XSL stylesheets.
NOTE: The URL reference to the current DocBook XSL stylesheets is
rewritten to point to the copy on the local disk drive by the XML catalog
rewrite directives so it doesn't need to go out to the Internet for the
stylesheets. This means you don't need to edit the <xsl:import> elements on
a machine by machine basis.
-->
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"/>
<xsl:import href="common.xsl"/>
<!-- Only render the link text -->
<xsl:template match="ulink">
<xsl:variable name="content">
<xsl:apply-templates/>
</xsl:variable>
<xsl:value-of select="$content"/>
</xsl:template>
<!-- Don't automatically generate the REFERENCES section -->
<xsl:template name="format.links.list">
</xsl:template>
</xsl:stylesheet>
Loading…
Cancel
Save