XSH(1)

xsh
xsh - XML Editing Shell

SYNOPSIS
  xsh [options] commands
  xsh [options] -al script [arguments ...]
  xsh [options] -p commands < input.xml > output.xml
  xsh [options] -I input.xml -O output.xml commands
  xsh [options] -P file.xml commands

  xsh -u          for usage
  xsh -h          for help
  xsh --man       for the manual page

DESCRIPTION
XSH is an shell-like language for XPath-oriented editing, querying and manipulation of XML and HTML files (with read-only support for DocBook SGML). "xsh" can work as an interactive shell (with full command-line support such as history, TAB-completion, etc.) or as an off-line interpreter for batch processing of XML files.

XSH COMMANDS
Please see <http://xsh.sourceforge.net/doc/frames/index.html> or XSH for a complete XSH language reference.

For a quick help, type "xsh help" (just "help" on xsh prompt).

Type "xsh help commands" to get list of available XSH commands and "xsh help command" with command replaced by a XSH command name to get help on a particular command.

OPTIONS

--load|-l script-file
    Load and execute given XSH script (the script is executed before all other commands provided on the command-line, but after executed ~/.xshrc).

--arguments|-a
    Command-line contains arguments accessible to the script via @XML::XSH::Map::ARGV rather than XSH commands.

--stdin|-t
    Don't display command-prompt even if run from a terminal, expecting XSH commands in the standard input.

--compile|-c
    Compile the XSH source and report errors, only. No commands are actually executed.

--quiet|-q
    Quiet mode: suppress all unnecessary informatory ouptut.

--format
    Start with indent 1 (on) and keep_blanks 0 (off) to allow nice indenting of the XML output.

--validation|-v
    Start with validation, load_ext_dtd, parser_expands_entities and parser_completes_attributes 1 (on).

--no-validation|-w
    Start with validation, load_ext_dtd, parser_expands_entities and parser_completes_attributes 0 (off).

--debug|-d
    Print some debug messages.

--no-init|-f
    Ignore ~/.xshrc

--version|-V
    Print XSH version info and exit.

--interactive|-i
    Start interactive mode with xsh command prompt. By default, the interactive mode is only started if "xsh" is running from a terminal and neither XSH commands nor a script are given on the command-line.

--non-interactive|-n
    Force non-interactive mode.

--pipe|-p
    This is a special mode in which xsh acts as a pipe-line processing tool. In this mode, first the standard input is read and opened as a document _ (underscore), then all XSH commands given in ~/.xshrc, command-line and given XSH scripts are applied and finally the (possibly modified) document _ is dumped back on the standard output. It is equivallent to "-I - -O -" and "-P -".

--input|-I filename
    Preload given file as a document with ID _ upon startup.

--output|-O filename
    Try to saves document with ID _ into given file before XSH ends.

--process|-P filename
    A convenient shortcut for "-I filename -O filename".

--html|-H
    Make XSH expect HTML documents by default in all open/save operations.

--xml|-X
    This option is included only for completeness sake. Make XSH expect XSH documents by default in all open/save operations (this is the default).

--trace-grammar|-T
    This option allows tracing the way XSH language parser processes your script.

--query-encoding|-E encoding
    Set the encoding that used in the XSH scripts (or keyboard input).

--encoding|-e encoding
    Set the encoding that should be used for XSH output.

--usage|-u
    Print a brief help message on usage and exits.

--help|-h
    Prints the help page and exits.

--man
    Displays the help as manual page.

AUTHOR
Petr Pajas <pajas@matfyz.cz>

Copyright 2000-2003 Petr Pajas, All rights reserved.