c/libxml2
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/libxml2 synced 2025-03-28 21:33:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Document all xmllint options

Browse Source 
Remove --pushsmall.

Fixes #785.
This commit is contained in:
Nick Wellnhofer 2024-08-28 22:03:30 +02:00
parent 67ff748c3e
commit 8ad618d2d6
2 changed files with 108 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
doc/xmllint.xml
View File

@ -72,8 +72,13 @@
<arg choice="plain"><option>--debugent</option></arg>
<arg choice="plain"><option>--copy</option></arg>
<arg choice="plain"><option>--recover</option></arg>
<arg choice="plain"><option>--huge</option></arg>
<arg choice="plain"><option>--nocompact</option></arg>
<arg choice="plain"><option>--nodefdtd</option></arg>
<arg choice="plain"><option>--nodict</option></arg>
<arg choice="plain"><option>--noenc</option></arg>
<arg choice="plain"><option>--noent</option></arg>
<arg choice="plain"><option>--nofixup-base-uris</option></arg>
<arg choice="plain"><option>--noout</option></arg>
<arg choice="plain"><option>--nonet</option></arg>
<arg choice="plain"><option>--path "<replaceable class="option">PATH(S)</replaceable>"</option></arg>
@ -99,6 +104,7 @@
<arg choice="plain"><option>--noblanks</option></arg>
<arg choice="plain"><option>--nocdata</option></arg>
<arg choice="plain"><option>--format</option></arg>
<arg choice="plain"><option>--pretty <replaceable class="option">INTEGER</replaceable></option></arg>
<arg choice="plain"><option>--encode <replaceable class="option">ENCODING</replaceable></option></arg>
<arg choice="plain"><option>--dropdtd</option></arg>
<arg choice="plain"><option>--nsclean</option></arg>
@ -115,18 +121,20 @@
<arg choice="plain"><option>--pattern <replaceable class="option">PATTERNVALUE</replaceable></option></arg>
<arg choice="plain"><option>--relaxng <replaceable class="option">SCHEMA</replaceable></option></arg>
<arg choice="plain"><option>--schema <replaceable class="option">SCHEMA</replaceable></option></arg>
<arg choice="plain"><option>--schematron <replaceable class="option">SCHEMA</replaceable></option></arg>
<arg choice="plain"><option>--c14n</option></arg>
<arg choice="plain"><option>--c14n11</option></arg>
<arg choice="plain"><option>--exc-c14n</option></arg>
<arg choice="plain"><option>--pedantic</option></arg>
<arg choice="plain"><option>--sax</option></arg>
<arg choice="plain"><option>--sax1</option></arg>
<arg choice="plain"><option>--oldxml10</option></arg>
</group>
<group choice="req">
<arg choice="plain" rep="repeat"><replaceable>XML-FILE(S)</replaceable></arg>
<arg choice="plain" rep="norepeat">-</arg>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>xmllint</command>
<arg choice="plain"><option>--help</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
@ -194,6 +202,8 @@
<varlistentry>
<term><option>--c14n</option></term>
<term><option>--c14n11</option></term>
<term><option>--exc-c14n</option></term>
<listitem>
<para>
Use the W3C <acronym>XML</acronym> Canonicalisation (<acronym>C14N</acronym>) to
@ -276,13 +286,6 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help</option></term>
<listitem>
<para>Print out a short usage summary for &xmllint;.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--html</option></term>
<listitem>
@ -302,6 +305,13 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--huge</option></term>
<listitem>
<para>Ignore some hardcoded parser limits.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--insert</option></term>
<listitem>
@ -379,6 +389,26 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--nocompact</option></term>
<listitem>
<para>
Do not generate compact text nodes (parser option
XML_PARSE_COMPACT). Only for debugging.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--nodefdtd</option></term>
<listitem>
<para>
Do not set default HTML doctype (parser option
HTML_PARSE_NODEFDTD).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--nodict</option></term>
<listitem>
@ -389,6 +419,16 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--noenc</option></term>
<listitem>
<para>
Ignore encoding declaration (parser option
XML_PARSE_IGNORE_ENC).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--noent</option></term>
<listitem>
@ -399,6 +439,16 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--nofixup-base-uris</option></term>
<listitem>
<para>
Don't fix xml:base URIs when processing XIncludes
(parser option XML_PARSE_NOBASEFIX).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--nonet</option></term>
<listitem>
@ -447,6 +497,16 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--oldxml10</option></term>
<listitem>
<para>
Use deprecated parsing rules before XML 1.0,
5th edition.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--output <replaceable class="option">FILE</replaceable></option></term>
<listitem>
@ -496,6 +556,16 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--pretty <replaceable class="option">INTEGER</replaceable></option></term>
<listitem>
<para>
Value 0 means no formatting, 1 means XML_SAVE_FORMAT
(same as --format), 2 means XML_SAVE_WSNONSIG.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--push</option></term>
<listitem>
@ -534,6 +604,20 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--sax</option></term>
<listitem>
<para>Print SAX callbacks (only for debugging).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--sax1</option></term>
<listitem>
<para>Use deprecated SAX1 interface (only for debugging).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--schema <replaceable>SCHEMA</replaceable></option></term>
<listitem>
@ -544,6 +628,16 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--schematron <replaceable>SCHEMA</replaceable></option></term>
<listitem>
<para>
Use a Schematron file
named <replaceable>SCHEMA</replaceable> for validation.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--shell</option></term>
<listitem>

11
xmllint.c
View File

@ -138,7 +138,7 @@ static int xmlout = 0;
static int htmlout = 0;
#ifdef LIBXML_PUSH_ENABLED
static int push = 0;
static int pushsize = 4096;
static const int pushsize = 4096;
#endif /* LIBXML_PUSH_ENABLED */
#if HAVE_DECL_MMAP
static int memory = 0;
@ -2690,7 +2690,6 @@ static void usage(FILE *f, const char *name) {
#endif
#ifdef LIBXML_PUSH_ENABLED
fprintf(f, "\t--push : use the push mode of the parser\n");
fprintf(f, "\t--pushsmall : use the push mode of the parser using tiny increments\n");
#endif /* LIBXML_PUSH_ENABLED */
#if HAVE_DECL_MMAP
fprintf(f, "\t--memory : parse from memory\n");
@ -2699,6 +2698,8 @@ static void usage(FILE *f, const char *name) {
fprintf(f, "\t--nowarning : do not emit warnings from parser/validator\n");
fprintf(f, "\t--noblanks : drop (ignorable?) blanks spaces\n");
fprintf(f, "\t--nocdata : replace cdata section with text nodes\n");
fprintf(f, "\t--nodict : create document without dictionary\n");
fprintf(f, "\t--pedantic : enable additional warnings\n");
#ifdef LIBXML_OUTPUT_ENABLED
fprintf(f, "\t--output file or -o file: save to a given file\n");
fprintf(f, "\t--format : reformat/reindent the output\n");
@ -2882,7 +2883,6 @@ xmllintMain(int argc, const char **argv, xmlResourceLoader loader) {
htmlout = 0;
#ifdef LIBXML_PUSH_ENABLED
push = 0;
pushsize = 4096;
#endif /* LIBXML_PUSH_ENABLED */
#if HAVE_DECL_MMAP
memory = 0;
@ -3063,11 +3063,6 @@ xmllintMain(int argc, const char **argv, xmlResourceLoader loader) {
else if ((!strcmp(argv[i], "-push")) ||
(!strcmp(argv[i], "--push")))
push++;
else if ((!strcmp(argv[i], "-pushsmall")) ||
(!strcmp(argv[i], "--pushsmall"))) {
push++;
pushsize = 10;
}
#endif /* LIBXML_PUSH_ENABLED */
#if HAVE_DECL_MMAP
else if ((!strcmp(argv[i], "-memory")) ||