essential command line
The basic command line is: “ssc folder”, which tells ssc to nitpick the static website found in folder.
ssc has many switches to allow you to precisely control how and what you want it to do. Most switches are normally not needed. The essential switches are:
| -h | output a list of switches |
| -f file | configuration is in file, such as ssc.conf |
| -v info | output info nits, and worse |
| -s domain | the site is for domain, such as ‘example.com’ |
all settings
These options are available as command line arguments (preceded by - or --, in the usual way) and in configuration files (without --). The short form single minus switches only work on the command line.
Most binary options that turn a feature on (which may be the default), have a corresponding no- switch to turn it off. The no- is inserted after the dot, so, for example, the contradiction to the imaginary switch general.noh would be general.no-noh. When both are specified, perhaps in a configuration file and on the command line, the no- switch applies.
Switches are documented as follows:
| atom | ATOM files |
| corpus | output XML for a local search engine |
| CSS | CSS version, which modules to verify |
| env | environment variables |
| HTML | HTML version and related switches |
| JSON-LD | JSON-LD files |
| link | link checking |
| MathML | MathML versions |
| microformat | microformat.org content |
| misc | other switches |
| nits | control nits |
| ontology | check ontologies, and specify versions |
| output | control output |
| RSL | RSL files |
| RSS | RSS files |
| shadow | output a ‘tidied up’ copy of the site |
| shell | command line only switches |
| site | information about the website being tested |
| spell | spell checking |
| SSI | server side includes |
| stats | output site statistics |
| SVG | SVG version |
| validate | additional valid values for attributes & properties |
| VTT | WebVTT validation and version |
Additional configuration information can be found in:
| config | Configuration file options and format |
| env | Environment variables |
| output | Precisely control output format |
exit status
If no significant nits are found, ssc exits with 0. Otherwise it exits with a value > 0. This is controlled with the general.error switch.
examples
To verify the version of ssc:
ssc -V
To nitpick the static web site found in wwwroot:
ssc wwwroot
To check a static HTML/XHTML website for example.com, which uses server
side includes, in the current directory, with verification of external
links, and rather verbose output:
ssc -e -I -x html -x shtml -s example.com -v 6 -i index.shtml
To check a static web side in the current directory, with a virtual
directory, verifying microformats:
ssc -L virtual=/home/site/virtual -M
To check a static web site using a configuration file:
ssc -f config.file
GUI
The GUI is to be reworked. Documentation will be posted when ready.