Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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

SCOLASYNC(1)						       scolasync User Manual						      SCOLASYNC(1)

NAME

       scolasync - a file manager dedicated to dealing with a collection of removable media, like music mobile players. It makes easier to copy
       files to a set of removable media, and to copy files from them.

SYNOPSIS

       scolasync [{-c | --check}]

DESCRIPTION

       scolasync allows you to send a series of files towards a set of removable media. Every individual removable storage device is identified,
       for example to its owner. Then, later, you can retreive modified files from the same collection of removable media and track the
       modifications attributable to each owner.

       A possible usage is with students learning a foreign language: they are given homework on their USB sticks, and they bring them back with
       modified contents to get scores.

OPTIONS

       -c , --check
	   Enables checkboxes to select a subset of the usb storage media currently plugged to your computer, even if the checkboxes are not
	   wanted in the preferences of the application.

FILES

       ${HOME}/.scolasync/db
	   A database containing the preferences of the application, and the mapping between owners and USB storage media.

       /usr/share/scolasync/marques.py
	   A dictionary of pecularities which come with some brands of USB storage media.

       ${HOME}/.scolasync/marques.py
	   This dictionary overrides the settings in the system-wide configuration.

       ${HOME}/.scolasync/scolasync.log
	   A log file for the application.

AUTHOR

       Georges Khaznadar <georgesk@ofset.org>
	   Wrote this manpage for the Debian system.

COPYRIGHT

       Copyright (C) 2010 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.

scolasync							    06/23/2012							      SCOLASYNC(1)
Man Page