Man page generation.

paulchan · Sep 10, 2009 · 68dda0a · 68dda0a
1 parent 8e5d4f9
commit 68dda0a
Show file tree

Hide file tree

Showing 11 changed files with 22 additions and 12 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,8 @@ tags
 .lock-wscript
 Makefile
 *.pyc
-website/api.html
+doc/api.html
+doc/api.xml
+doc/node.1
 node
 node_g
diff --git a/configure b/configure
@@ -106,20 +106,25 @@ test-debug: all
 benchmark: all
 	build/default/node benchmark/run.js
 
-website: website/api.html website/index.html
+doc: doc/node.1 doc/api.html doc/index.html
 
-website/api.html: website/api.txt
+doc/api.html: doc/api.txt
 	asciidoc --unsafe              \\
 		-a theme=pipe                \\
 		-a toc                       \\
 		-a linkcss                   \\
-		-o website/api.html website/api.txt
+		-o doc/api.html doc/api.txt
 
-#		-a stylesdir=website/   \\
-#		-a scriptsdir=website/   \\
+doc/api.xml: doc/api.txt
+	asciidoc -b docbook -d manpage -o doc/api.xml doc/api.txt
 
-website-upload: website
-	scp website/* linode:~/tinyclouds/node/
+doc/node.1: doc/api.xml
+	xsltproc --output doc/node.1                \\
+		--nonet /etc/asciidoc/docbook-xsl/manpage.xsl \\
+		doc/api.xml
+
+website-upload: doc
+	scp doc/* linode:~/tinyclouds/node/
 
 clean:
 	@$WAF clean
@@ -136,7 +141,7 @@ check:
 dist:
 	@$WAF dist
 
-.PHONY: benchmark clean dist distclean check uninstall install all test test-all website website-upload
+.PHONY: benchmark clean dist distclean check uninstall install all test test-all website-upload
 
 EOF
 }

diff --git a/website/api.txt → doc/api.txt b/website/api.txt → doc/api.txt
@@ -4,13 +4,13 @@ Ryan Dahl <ry@tinyclouds.org>
 Version, 0.1.9, 2009.09.05
 
 
-== Name
+== NAME
 
 node - evented I/O for V8 javascript
 
 
 
-== Synopsis
+== SYNOPSIS
 
 An example of a web server written with Node which responds with "Hello
 World" after waiting two seconds:

diff --git a/website/index.html → doc/index.html b/website/index.html → doc/index.html
diff --git a/website/pipe.css → doc/pipe.css b/website/pipe.css → doc/pipe.css
diff --git a/website/sh_javascript.min.js → doc/sh_javascript.min.js b/website/sh_javascript.min.js → doc/sh_javascript.min.js
diff --git a/website/sh_main.js → doc/sh_main.js b/website/sh_main.js → doc/sh_main.js
diff --git a/website/sh_vim-dark.css → doc/sh_vim-dark.css b/website/sh_vim-dark.css → doc/sh_vim-dark.css
diff --git a/website/toc.js → doc/toc.js b/website/toc.js → doc/toc.js
diff --git a/src/node.cc b/src/node.cc
@@ -446,7 +446,9 @@ PrintHelp ( )
   printf("Usage: node [switches] script.js [arguments] \n"
          "  -v, --version    print node's version\n"
          "  --cflags         print pre-processor and compiler flags\n"
-         "  --v8-options     print v8 command line options\n");
+         "  --v8-options     print v8 command line options\n\n"
+         "Documentation can be found at http://tinyclouds.org/node/api.html"
+         " or with 'man node'\n");
 }
 
 static void

diff --git a/wscript b/wscript
@@ -347,3 +347,4 @@ def build(bld):
     src/events.h
     src/net.h
   """);
+  bld.install_files('${PREFIX}/share/man/man1/', 'doc/node.1');