Commit 42304046 authored by MST 2001 John Fleck's avatar MST 2001 John Fleck Committed by John Fleck
Browse files

doc/xmllint.xml, doc/xmllint.1 - update xmllint man page with shell


Sat Nov 17 17:16:51 MST 2001 John Fleck <jfleck@inkstain.net>

	* doc/xmllint.xml, doc/xmllint.1 - update xmllint man page with
	shell instructions from Heiko Rupp
parent f7b094f7
Sat Nov 17 17:16:51 MST 2001 John Fleck <jfleck@inkstain.net>
* doc/xmllint.xml, doc/xmllint.1 - update xmllint man page with
shell instructions from Heiko Rupp
Thu Nov 15 14:53:42 CET 2001 Daniel Veillard <daniel@veillard.com>
* catalog.c: use the URL notation file:// for default catalog paths
......
......@@ -45,7 +45,7 @@ Parse a file and output an annotated tree of the in-memory version of the docume
.TP
\fB--shell\fR
Run a navigating shell.
Run a navigating shell. Details on available commands in shell mode are below.
.TP
\fB--debugent\fR
......@@ -192,10 +192,95 @@ Fetch external DTD.
Fetch external DTD and populate the tree with inherited attributes.
.SH "SHELL"
.PP
xmllint offers an interactive shell mode invoked with the \fB--shell\fR command. Available commands in shell mode include:
.TP
\fBbase\fR
display XML base of the node
.TP
\fBbye\fR
leave shell
.TP
\fBcat \fInode\fR\fR
Display node if given or current node.
.TP
\fBcd \fIpath\fR\fR
Change the current node to \fIpath\fR (if given and unique) or root if no argument given.
.TP
\fBdir \fIpath\fR\fR
Dumps information about the node (namespace, attributes, content).
.TP
\fBdu \fIpath\fR\fR
Show the structure of the subtree under path or the current node.
.TP
\fBexit\fR
Leave the shell.
.TP
\fBhelp\fR
Show this help.
.TP
\fBfree\fR
Display memory usage.
.TP
\fBload \fIname\fR\fR
Load a new document with the given name.
.TP
\fBls \fIpath\fR\fR
List contents of \fIpath\fR (if given) or the current directory.
.TP
\fBpwd\fR
Display the path to the current node.
.TP
\fBquit\fR
Leave the shell.
.TP
\fBsave \fIname\fR\fR
Saves the current document to \fIname\fR if given or to the original name.
.TP
\fBvalidate\fR
Check the document for error.
.TP
\fBwrite \fIname\fR\fR
Write the current node to the given filename.
.SH AUTHOR
Copyright 2001
.Sp
John Fleck <jfleck@inkstain.net>Ziying Sherwin <sherwin@nlm.nih.gov>
John Fleck <jfleck@inkstain.net>Ziying Sherwin <sherwin@nlm.nih.gov>Heiko Rupp <hwr@pilhuhn.de>
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License: \fIgnome-help:fdl\fR, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be found here: \fIgnome-help:fdl\fR.
......
......@@ -18,6 +18,11 @@
<surname>Sherwin</surname>
</author>
<address><email>sherwin@nlm.nih.gov</email></address>
<author>
<firstname>Heiko</firstname>
<surname>Rupp</surname>
</author>
<address><email>hwr@pilhuhn.de</email></address>
<legalnotice id="legalnotice">
<para>Permission is granted to copy, distribute and/or modify this document
under the terms of the <ulink type="help" url="gnome-help:fdl"><citetitle>GNU Free Documentation
......@@ -128,7 +133,8 @@
<term><option>--shell</option></term>
<listitem>
<simpara>
Run a navigating shell.
Run a navigating shell. Details on available commands in shell mode
are below.
</simpara>
</listitem>
</varlistentry>
......@@ -414,4 +420,147 @@
</variablelist>
</refsect1>
</refentry>
\ No newline at end of file
<refsect1 id="shell">
<title>Shell</title>
<para>
<application>xmllint</application> offers an interactive shell mode
invoked with the <option>--shell</option> command. Available commands in
shell mode include:
</para>
<variablelist>
<varlistentry>
<term><option>base</option></term>
<listitem>
<simpara>
display XML base of the node
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>bye</option></term>
<listitem>
<simpara>
leave shell
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>cat <replaceable>node</replaceable></option></term>
<listitem>
<simpara>
Display node if given or current node.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>cd <replaceable>path</replaceable></option></term>
<listitem>
<simpara>
Change the current node to <replaceable>path</replaceable> (if given
and unique) or root if no argument given.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>dir <replaceable>path</replaceable></option></term>
<listitem>
<simpara>
Dumps information about the node (namespace, attributes, content).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>du <replaceable>path</replaceable></option></term>
<listitem>
<simpara>
Show the structure of the subtree under path or the current node.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>exit</option></term>
<listitem>
<simpara>
Leave the shell.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>help</option></term>
<listitem>
<simpara>
Show this help.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>free</option></term>
<listitem>
<simpara>
Display memory usage.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>load <replaceable>name</replaceable></option></term>
<listitem>
<simpara>
Load a new document with the given name.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>ls <replaceable>path</replaceable></option></term>
<listitem>
<simpara>
List contents of <replaceable>path</replaceable> (if given) or the
current directory.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>pwd</option></term>
<listitem>
<simpara>
Display the path to the current node.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>quit</option></term>
<listitem>
<simpara>
Leave the shell.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>save <replaceable>name</replaceable></option></term>
<listitem>
<simpara>
Saves the current document to <replaceable>name</replaceable> if
given or to the original name.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>validate</option></term>
<listitem>
<simpara>
Check the document for error.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>write <replaceable>name</replaceable></option></term>
<listitem>
<simpara>
Write the current node to the given filename.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment