jsdoc(1) [debian man page]
JSDOC-TOOLKIT(1) jsdoc-toolkit User Manual JSDOC-TOOLKIT(1) NAME
jsdoc - automatic generator for HTML documentation of Javascript sources SYNOPSIS
jsdoc {-d=<PATH> | --directory=<PATH>} [options] <SRC_DIR_OR_FILE> ... jsdoc [{-h | --help}] DESCRIPTION
This manual page documents briefly the jsdoc command. jsdoc is application, written in JavaScript, for automatically generating template-formatted, multi-page HTML (or XML, JSON, or any other text-based) documentation from commented JavaScript source code. OPTIONS
The program follows the usual GNU command line syntax, with long options starting with two dashes (`-'). A summary of options is included below. For a complete description, see the info(1) files. -a, --allfunction Include all functions, even undocumented ones. -c, --conf Load a configuration file. -d=<PATH>, --directory=<PATH> Output to this directory (required parameter). -D="myVar:My value", --define="myVar:My value" Multiple. Define a variable, available in JsDoc as JSDOC.opt.D.myVar. -e=<ENCODING>, --encoding=<ENCODING> Use this encoding to read and write files. -E="REGEX", --exclude="REGEX" Multiple. Exclude files based on the supplied regex. -h, --help Show this message and exit. -m, --multiples Don't warn about symbols being documented more than once. -n, --nocode Ignore all code, only document comments with @name tags. -o=<PATH>, --out=<PATH> Print log messages to a file (defaults to stdout). -p, --private Include symbols tagged as private, underscored and inner symbols. -q, --quiet Do not output any messages, not even warnings. -r=<DEPTH>, --recurse=<DEPTH> Descend into src directories. -s, --suppress Suppress source code output. -S, --securemodules Use Secure Modules mode to parse source code. -t=<PATH>, --template=<PATH> Use this template to format the output. -T, --test Run all unit tests and exit. -u, --unique Force file names to be unique, but not based on symbol names. -v, --verbose Provide verbose feedback about what is happening. -x=<EXT>[,EXT]..., --ext=<EXT>[,EXT]... Scan source files with the given extension/s (defaults to js). BUGS
The following bugs are known bugs: Does not support spaces in arguments The wrapper jsdoc is not immune to spaces in filenames, either escaped or not. AUTHOR
Georges Khaznadar <georgesk@ofset.org> Wrote this manpage for the Debian system. COPYRIGHT
Copyright (C) 2011 Georges Khaznadar This manual page was written for the Debian system (and may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or (at your option) any later version published by the Free Software Foundation. On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL-2. jsdoc-toolkit 07/16/2011 JSDOC-TOOLKIT(1)
Check Out this Related Man Page
DRBLSRV(8) Administration commands DRBLSRV(8) NAME
drblsrv - program to make a DRBL server SYNOPSIS
drblsrv [{-f | --force-yes}] [{-i | --install}] [{-u | --uninstall}] [{-v | --verbose}] [{-t | --testing} {y | n}] [{-a | --unstable} {y | n}] [{-n | --netinstall} {y | n}] [{-m | --smp-client} {y | n}] [{-x | --set-proxy} {y | n}] [{-c | --console-output} {y | n}] [{-g | --upgrade_system} {y | n}] [{-k | --client_archi} {0 | 1 | 2}] [{-o | --client_kernel_from} {1 | 2}] [{-s | --skip-select-repository}] [{-l | --language} {0 | 1 | 2}] drblsrv [{-h | --help} | {-v | --version}] DESCRIPTION
drblsrv is a program to build or maintain a DRBL server. OPTIONS
The program follows the usual GNU command line syntax, with long options starting with two dashes (`-'). A summary of options is included below. -f, --force-yes force yes, only for Debian-like distribution. It should not be used except in very special situations. Using force-yes can potentially destroy your system! -i, --install install DRBL. -u, --uninstall uninstall DRBL. -v, --verbose verbose mode. -t [y/n], --testing [y/n] use packages in testing branch or not. -a [y/n], --unstable [y/n] use packages in unstable branch or not. -n [y/n], --netinstall [y/n] install the network installation program or not. -m [y/n], --smp-client [y/n] use SMP kernel for DRBL clients or not. -x [y/n], --set-proxy [y/n] set proxy or not. -c [y/n], --console-output [y/n] set console output for client or not. -g [y/n], --upgrade_system [y/n] upgrade system or not. -k [0|1|2], --client_archi [0|1|2] set the client's CPU arch, 0 for i386, 1 for i586, 2 for same level with DRBL server (for x86_64, use 2). -o [1|2], --client_kernel_from [1|2] choose client's kernel image from, 1 from DRBL server running kernel (if available), 2 from ayo repository. -s, --skip-select-repository skip the question for selecting repository. -l [N], --language [N] Set the language to be shown, where N: 0: English, 1: Traditional Chinese (Big5) - Taiwan, 2: Traditional Chinese (UTF-8, Unicode) - Taiwan. -h, --help Show summary of options. -v, --version Show version of program. FILES
/etc/drbl/drbl.conf The system-wide configuration file to control the behaviour of drblsrv. See drbl.conf(5) for further details. ${HOME}/.drbl.conf The per-user configuration file to control the behaviour of drblsrv. See drbl.conf(5) for further details. ENVIRONMENT
DRBL_SCRIPT_PATH If used, the defined path is used to access each of drbl's routine scripts. DIAGNOSTICS
The following diagnostics may be issued on stderr: Any error messages worth to be reported in this manpage? If so, they should be documented here. drblsrv provides some return codes, that can be used in scripts: Code Diagnostic 0 Program exited successfully. 1 is such documentation useful? If no, erase it. KNOWN BUGS
The program is currently limited to only work with ... [some known bugs?] SEE ALSO
drbl.conf(5), drblpush(8) AUTHORS
Georges Khaznadar <georgesk@ofset.org> Wrote this manpage for the Debian system, based on the output of the command "drblsrv -h". Steven Shiau <steven@nchc.org.tw> Wrote the command drblsrv, including its short documentation. COPYRIGHT
Copyright (C) 2011 Georges Khaznadar This manual page was written for the Debian system (and may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or (at your option) any later version published by the Free Software Foundation. On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL. drblsrv 12/27/2011 DRBLSRV(8)