FreeBSD Manual Pages
SQLITE2HTML(1) General Commands Manual SQLITE2HTML(1) NAME sqlite2html -- convert sqlite3 schema to an HTML5 fragment SYNOPSIS sqlite2html [-v] [-p prefix] [schema] DESCRIPTION The sqlite2html utility converts an sqlite3(1) schema file to an HTML5 fragment. Its options are as follows: -v Causes the parser to emit informational messages on stderr. -p prefix Prefix to use for creating HTML ID tags. schema An SQLite schema file. The outputted HTML5 fragment consists of a <dl class="tabs"> list consisting of tables; and then for each table, a <dl class="cols"> list of columns. The <dt> for each list entry consists of the name of the table or column and has its ID at- tribute set to the transformed name. The <dd> for each list begins with a <div class="comment"> if the table or column is preceeded by comments For columns with a foreign key reference, this will be preceeded by <div class="foreign"> containing an anchor to the key having a text node of the endpoint. The @ character within a comment is special: the following ta- ble name and optional column name will be transformed into an HTML link to the identifier. Thus, @foo.bar will point to the "bar" column in table "foo". If this identifier is not fol- lowed by white-space, you may quote the identifier to prevent subsequent characters from being pulled into the identifier, e.g., @"foo.bar". If you wish to print a standalone @, you may escape it with a backslash ("\"). The [ character is similar, as it encloses general-purpose links in a manner similar to Markdown. Links are formatted as follows: [link text](http://link) [http://link] You can escape the [ character as well, to prevent this behav- iour. The following sequences are also special: -- Print an formatted n-dash. --- Print an formatted m-dash. `` Print formatted left-double quotes. '' Print formatted right-double quotes. Any of these may be escaped with the backslash to have it print as-is. If you wish to print a backslash, you must escape it, for example, the \\-character---and an \@-sign. Lastly, a blank (without any white-space but the newline!) one- line comment line is considered to be a paragraph break, for example: -- Hello, world. -- -- And after the break... In multi-line comment, this can be affected with a blank line in the comment stream: /* * Hello, world. * * That was another line break. */ SEE ALSO sqlite2dot(1), sqlite3(1) CAVEATS The schema language accepted by sqlite2html is currently limited to the table declaration with a subset of the column specification. FreeBSD ports 15.0 June 30, 2016 SQLITE2HTML(1)
NAME | SYNOPSIS | DESCRIPTION | SEE ALSO | CAVEATS
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=sqlite2html&sektion=1&manpath=FreeBSD+Ports+15.0>