Use: ./sinad [command] [optional_args] to launch sinad. Sinad will read/write files in the current folder and its sub-folders. One command must be provided, and optionally some other arguments that will act as modifiers for the command.
Examples:
# Create a new folder named "example" for a new presentation
sinad --init example
# Modify example/content.txt with your preferred text editor
cd example
sinad --edit
# Run sinad in build mode to generate hmtl slides
sinad --build
# Open the result (html/slide0000.html, or html/index.html) with your preferred browser
sinad --show
# Keep sinad open monitorizing content.txt to launch build command every time it changes
sinad --auto
# Run sinad to convert presentation to pdf, and save it in "present.pdf"
sinad --pdf present.pdf
--init <name> |
create a new folder and copy basic files from a template (to create a new empty presentation) |
|
--build |
generate the html presentation |
|
--autobuild |
loop testing every 3 secons if content file has chaged to automatically regenerate the html files |
|
--pdf <fname> |
generate a pdf version of the presentation in file <fname> (see "dependencies and config file") |
|
--update |
copy style files from a template and overwrite current folder's ones (to update the template in an existing presentation) warning: will overwrite files in ./base/ and ./extra |
|
--update-base |
similar to --update, but only for ./base |
|
--update-extra |
similar to --update, but only for ./extra |
|
--clean |
delete all generated files (from --build and --pdf) warning: will recursively erase ./html and ./tmp |
|
--cleantmp |
delete all generated files (from --pdf) warning: will recursively erase ./tmp |
|
--generate-conf |
generates a new "sinad.conf" sample file in the current working dir |
|
--show |
open the result in your default web browser |
|
--edit |
open the content file in your default text editor |
|
--version |
display version and about information |
|
--help |
display this help |
--content <fname> |
use <fname> as content file (--build,--pdf, --autobuild) default is: content.txt |
|
--extra <path> |
use <fname> as extra content (css, images, etc) to be copied to output folder (--build,--pdf, --autobuild) default is: ./extra default is: content.txt |
|
--template <path> |
use <path> as template's path (for --init or --update) default is "/usr/local/share/sinad/default" |
|
--base <path> |
use <path> as template's base folder (--build, --pdf, --autobuild) default is: ./base |
|
--temp <path> |
use <path> as folder for intermediate temporal files (--pdf,--clean) default is: tmp |
|
--output <path> |
use <path> as output folder, default is: ./html (--build,--clean, --autobuild) |
|
--ttp |
convert text to paths when exporting svg files (requires inkscape) |
|
--anim |
consider ##time and ##pause commands (default mode for --build and --autobuild) |
|
--noanim |
do not consider ##time and ##pause commands (default mode for --pdf) --interval <time> change the 3 seconds inverval for autobuild to <time> secons (--autobuild) |
|
--watch <file> |
set which file's modification date should be compare with the generated index.txt's one to determine whether to rebuild (--autobuild) default is: --content's value <time> secons (--autobuild) |
|
--force |
do not ask before deleting files (--clean) |
|
--quiet |
silence progress messages (--build,--pdf,--autobuild) |
|
--notify |
use system notifications for syntax errorcs |
|
--nocolor |
do not use colores in terminal output |
|
--noembed |
replace embed command with image, to avoids a bug in some versions of wkhtml2pdf or webkit |
--auto |
short for "--autobuild --quiet --notify" |