Skip to content

Latest commit

 

History

History
89 lines (45 loc) · 2.46 KB

rng2vim.pod

File metadata and controls

89 lines (45 loc) · 2.46 KB
Raw

NAME

rng2vim - Convert a RELAX NG schema to an XML data file for Vim

SYNOPSIS

rng2vim [-ix] [-a name] [-l language] [-m name] [-u url] schema name

rng2vim -h|-v

DESCRIPTION

rng2vim provides means to generate an XML data file for Vim's omni completion from a RELAX NG schema. It accepts a path or a link to the RELAX NG schema file and the name of the XML dialect as the command line arguments, and creates the corresponding XML data file in the current working directory.

OPTIONS

-a name, --author name

Use name as the name of the author in the XML data file header.

-l language, --language language

Use language as the language in the XML data file header.

-m name, --maintainer name

Use name as the name of the maintainer in the XML data file header.

-u url, --url url

Use url as the URL in the XML data file header.

-i, --interactive

Prompt before overwriting an existing file.

-x, --xhtml-entities

Use character entity references documented in the XHTML 1.0 specification instead of those defined in the XML 1.1 standard.

-h, --help

Display usage information and immediately terminate the script.

-v, --version

Display version information and immediately terminate the script.

EXAMPLES

  • To generate an XML data file named "docbook50.vim" from a DocBook 5.0 schema located online at <http://www.docbook.org/xml/5.0/rng/docbook.rng>, type the following at a shell prompt:

    rng2vim http://www.docbook.org/xml/5.0/rng/docbook.rng docbook50

  • To generate an XML data file from a RELAX NG schema stored in the current working directory, type:

    rng2vim docbook.rng docbook50

  • To generate an XML data file with support for all 253 character entity references that are documented in the XHMTL 1.0 specification, use the following command:

    rng2vim -x docbook.rng docbook50

SEE ALSO

vim(1)

BUGS

To report bugs or to submit patches, please, create a new issue at <https://github.com/jhradilek/rng2vim/issues/>.

COPYRIGHT

Copyright (C) 2013 Jaromir Hradilek

This program is free software; see the source for copying conditions. It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.