Usage¶
The usage is as simple as:
$ doc2dash -A <docdir>
doc2dash
will create a new directory called <docdir>.docset
in ~/Library/Application Support/doc2dash/DocSets
containing a Dash.app-compatible docset.
When finished, the docset is automatically added to Dash.app.
Options and Arguments¶
The full usage is:
$ doc2dash [OPTIONS] SOURCE
The SOURCE
is a directory containing the documentation you would like to convert.
Valid OPTIONS
are the following:
-
-n
,
--name
¶
Name the docset explicitly instead of letting doc2dash guess the correct name from the directory name of the source.
-
-d
PATH
,
--destination
PATH
¶ Put the resulting docset into
PATH
. Default is the current directory. Ignored if--add-to-global
is specified.
-
-f
,
--force
¶
Overwrite docset if it already exists. Otherwise,
doc2dash
would exit with an error.
-
-i
FILENAME
,
--icon
FILENAME
¶ Add PNG icon
FILENAME
to docset that is used within Dash.app to represent the docset.
-
-I
FILENAME
,
--index-page
FILENAME
¶ Set the file that is shown when the docset is clicked within Dash.app.
-
-a
,
--add-to-dash
¶
Automatically add the resulting docset to Dash.app. Works only on OS X and when Dash.app is installed.
-
-A
,
--add-to-global
¶
Create docset in doc2dash’s default global directory [
~/Library/Application Support/ doc2dash/DocSets
] and add it to Dash.app Works only on OS X and when Dash.app is installed.
-
-q
,
--quiet
¶
Limit output to errors and warnings.
-
-v
,
--verbose
¶
Be verbose.
-
--version
¶
Show the version and exit.
-
--help
¶
Show a brief usage summary and exit.