Man page generation.

2025-12-28 07:50:41 +00:00 · 2009-09-10 13:40:38 +02:00 · 2009-09-10 13:40:38 +02:00 · 68dda0a7d8
commit 68dda0a7d8
parent 8e5d4f9a69
11 changed files with 22 additions and 12 deletions
--- 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
--- a/21
+++ b/21
@ -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
 }
--- a/website/api.txt
+++ b/website/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:
--- a/website/index.html
+++ b/website/index.html
--- a/website/pipe.css
+++ b/website/pipe.css
--- a/website/sh_javascript.min.js
+++ b/website/sh_javascript.min.js
--- a/website/sh_main.js
+++ b/website/sh_main.js
--- a/website/sh_vim-dark.css
+++ b/website/sh_vim-dark.css
--- a/website/toc.js
+++ b/website/toc.js
--- 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
--- a/1
+++ b/1
@ -347,3 +347,4 @@ def build(bld):
    src/events.h
    src/net.h
  """);
+  bld.install_files('${PREFIX}/share/man/man1/', 'doc/node.1');