io7m | single-page | multi-page | xstructural 2.2.0-SNAPSHOT
3. Command-Line Interface
Previous
3. Command-Line Interface
Up
3.2. EPUB
Next

# 3.1. Overview

1
The xstructural package provides a command-line interface for performing tasks such as validating input documents, and transforming documents to various output formats. The base xstructural command is broken into a number of subcommands which are documented over the following sections.

### 3.1.2. Command-Line Overview

    xstructural: Main: INFO: Arguments required.
    Usage: xstructural [options] [command] [command options]
      Options:
        --verbose
          Set the minimum logging verbosity level
          Default: info
          Possible Values: [trace, debug, info, warn, error]
      Commands:
        epub      Transform a structural document to an EPUB
          Usage: epub [options]
            Options:
              --messagesFile
                The output file for XSLT messages
            * --outputDirectory
                The output directory
              --outputFileName
                The output file name
            * --sourceFile
                The source document
              --traceFile
                The output file for trace messages
              --verbose
                Set the minimum logging verbosity level
                Default: info
                Possible Values: [trace, debug, info, warn, error]

        schema      Export the structural schemas to files
          Usage: schema [options]
            Options:
            * --outputDirectory
                The output directory
              --replace
                Replace output files if they already exist
                Default: false
              --verbose
                Set the minimum logging verbosity level
                Default: info
                Possible Values: [trace, debug, info, warn, error]

        validate      Validate a structural document
          Usage: validate [options]
            Options:
            * --sourceFile
                The source document
              --verbose
                Set the minimum logging verbosity level
                Default: info
                Possible Values: [trace, debug, info, warn, error]

        validate-xhtml      Validate an XHTML document
          Usage: validate-xhtml [options]
            Options:
            * --sourceDirectory
                The source directory
              --verbose
                Set the minimum logging verbosity level
                Default: info
                Possible Values: [trace, debug, info, warn, error]

        xhtml      Transform a structural document to XHTML
          Usage: xhtml [options]
            Options:
              --brandingFile
                The branding XML file
              --copyResources
                Should resources (such as CSS) be copied into the output
                directory?
                Default: true
              --messagesFile
                The output file for XSLT messages
            * --outputDirectory
                The output directory
            * --sourceFile
                The source document
              --stylesheet
                The stylesheet
                Default: SINGLE_FILE
                Possible Values: [SINGLE_FILE, MULTIPLE_FILE, EPUB]
              --traceFile
                The output file for trace messages
              --verbose
                Set the minimum logging verbosity level
                Default: info
                Possible Values: [trace, debug, info, warn, error]

3. Command-Line Interface
Previous
3. Command-Line Interface
Up
3.2. EPUB
Next
io7m | single-page | multi-page | xstructural 2.2.0-SNAPSHOT