Difference between revisions of "Documentation"

From AOLserver Wiki
Jump to navigation Jump to search
(Added links to Command line and Configuration Reference)
 
(6 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
If there is documentation you feel is not complete, represented accurately, or is entirely omitted, please add it to the appropriate place and make a note of it on the [[Documentation Wishlist]] so that people know that someone wants it.
 
If there is documentation you feel is not complete, represented accurately, or is entirely omitted, please add it to the appropriate place and make a note of it on the [[Documentation Wishlist]] so that people know that someone wants it.
  
 +
== Command Line Reference ==
 +
* [[Command Line Reference]]
 +
== Configuration Reference ==
 +
* [[Conf|Configuration Reference]]
 +
* [[Conf/Examples| Example Configs]]
 
== API documentation ==
 
== API documentation ==
  
* [[Tcl API]]
+
* [[Tcl API]] - [http://aolserver.am.net/downloads/tcl-core.tip download] Komodo Tcl syntax method tip/auto-completion file
 
* [[C API]] - [http://aolserver.am.net/cvs/tcl C source for Tcl commands]
 
* [[C API]] - [http://aolserver.am.net/cvs/tcl C source for Tcl commands]
 
* [[Private C API]]
 
* [[Private C API]]
Line 15: Line 20:
 
* [[Toolkits]]
 
* [[Toolkits]]
 
* [[Tutorials]]
 
* [[Tutorials]]
* [[Administration]]
+
* [[Administration]] and Configuration
  
 
== Guides ==
 
== Guides ==
Line 34: Line 39:
 
* [[How to set up SQL-Ledger to serve from AOLserver]]
 
* [[How to set up SQL-Ledger to serve from AOLserver]]
 
* [[How to generate self-signed SSL certificates]]
 
* [[How to generate self-signed SSL certificates]]
 +
* [[How to configure single server to listen on multiple TCP ports]]
 +
* [[How to add TWAPI extension under AOLserver]]
 +
* [[How to start stop AOLserver using Daemontools]]
  
 
== Community-supported documentation ==
 
== Community-supported documentation ==

Latest revision as of 11:24, 9 July 2012

There is an effort underway to update and prepare documentation for AOLserver 4.0. This wiki will be the canonical source for documentation under revision, which will then get commited to CVS in the doc/ directory in roff format. From there, HTML will be forward-generated from the roff and made available from http://aolserver.com/docs/.

If there is documentation you feel is not complete, represented accurately, or is entirely omitted, please add it to the appropriate place and make a note of it on the Documentation Wishlist so that people know that someone wants it.

Command Line Reference

Configuration Reference

API documentation

General documentation

Guides

HOWTOs

Community-supported documentation

  • Tcl for Web Nerds is a book by MIT professors Hal Abelson, Philip Greenspun, and Lydia Sandon which covers Tcl programming with the AOL Server