<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE doc SYSTEM "doc.dtd">
<doc>
    <config><config-section-list></config-section-list></config>

    <operation>
        <operation-general>
            <option-list>
                <option id="beta"><summary></summary><text><p></p></text></option>
                <option id="cmd"><summary></summary><text><p></p></text></option>
                <option id="config"><summary></summary><text><p></p></text></option>
                <option id="config-path"><summary></summary><text><p></p></text></option>
                <option id="config-include-path"><summary></summary><text><p></p></text></option>
                <option id="pg"><summary></summary><text><p></p></text></option>
                <option id="pg-path"><summary></summary><text><p></p></text></option>
                <option id="compress-level-network"><summary></summary><text><p></p></text></option>
                <option id="job-retry"><summary></summary><text><p></p></text></option>
                <option id="job-retry-interval"><summary></summary><text><p></p></text></option>
                <option id="lock"><summary></summary><text><p></p></text></option>
                <option id="log-level-file"><summary></summary><text><p></p></text></option>
                <option id="log-level-stderr"><summary></summary><text><p></p></text></option>
                <option id="repo"><summary></summary><text><p></p></text></option>
                <option id="repo-type"><summary></summary><text><p></p></text></option>
                <option id="spool-path"><summary></summary><text><p></p></text></option>
                <option id="stanza"><summary></summary><text><p></p></text></option>

                <option id="buffer-size">
                    <summary>Buffer size for I/O operations.</summary>

                    <text>
                        <p>Buffer size used for copy, compress, encrypt, and other operations. The number of buffers used depends on options and each operation may use additional memory, e.g. <id>gz</id> compression may use an additional 256KiB of memory.</p>

                        <p>Allowed values are <id>16KiB</id>, <id>32KiB</id>, <id>64KiB</id>, <id>128KiB</id>, <id>256KiB</id>, <id>512KiB</id>, and <id>1MiB</id>.</p>
                    </text>

                    <example>1MiB</example>
                </option>

                <option id="log-level">
                    <summary>Level for harness logging.</summary>

                    <text>
                        <p>Log level for the test harness (as opposed to the test being run).</p>

                        <p>The following log levels are supported:</p>

                        <list>
                            <list-item><id>off</id> - No logging at all (not recommended)</list-item>
                            <list-item><id>error</id> - Log only errors</list-item>
                            <list-item><id>warn</id> - Log warnings and errors</list-item>
                            <list-item><id>info</id> - Log info, warnings, and errors</list-item>
                            <list-item><id>detail</id> - Log detail, info, warnings, and errors</list-item>
                            <list-item><id>debug</id> - Log debug, detail, info, warnings, and errors</list-item>
                            <list-item><id>trace</id> - Log trace (very verbose debugging), debug, info, warnings, and errors</list-item>
                        </list>
                    </text>

                    <example>error</example>
                </option>

                <option id="log-timestamp">
                    <summary>Enable timestamp in logging.</summary>

                    <text>
                        <p>Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.</p>
                    </text>

                    <example>n</example>
                </option>

                <option id="neutral-umask">
                    <summary>Use a neutral umask.</summary>

                    <text>
                        <p>Sets the umask to 0000 so modes are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.</p>

                        <p>To use the executing user's umask instead specify <setting>neutral-umask=n</setting> in the config file or <setting>--no-neutral-umask</setting> on the command line.</p>
                    </text>

                    <example>n</example>
                </option>

                <option id="repo-path">
                    <summary>Path to code repository.</summary>

                    <text>
                        <p>Path to the original code repository.</p>
                    </text>

                    <example>/path/to/pgbackrest</example>
                </option>
            </option-list>
        </operation-general>

        <command-list>
            <command id="help">
                <summary>Get help.</summary>

                <text>
                    <p>Three levels of help are provided. If no command is specified then general help will be displayed. If a command is specified (e.g. <cmd>doc-pgbackrest help build</cmd>) then a full description of the command will be displayed along with a list of valid options. If an option is specified in addition to a command (e.g. <cmd>doc-pgbackrest help build repo-path</cmd>) then a full description of the option as it applies to the command will be displayed.</p>
                </text>

                <option-list>
                    <option id="help" name="Display Help">
                        <summary>Display help.</summary>

                        <text>
                            <p>Displays help even if the <cmd>help</cmd> command is not specified and overrides the <br-option>--version</br-option> option.</p>
                        </text>

                        <example>y</example>
                    </option>

                    <option id="version" name="Display Version">
                        <summary>Display version.</summary>

                        <text>
                            <p>Displays version even if the <cmd>version</cmd> or <cmd>help</cmd> command is not specified.</p>
                        </text>

                        <example>y</example>
                    </option>
                </option-list>
            </command>

            <!-- Noop command holds options that must be defined but we don't need -->
            <command id="noop"><summary></summary><text><p></p></text></command>

            <command id="build">
                <summary>Build documentation.</summary>

                <text>
                    <p>Build the specified documentation module.</p>
                </text>
            </command>

            <command id="version">
                <summary>Get version.</summary>

                <text>
                    <p>Displays installed <backrest/> version.</p>
                </text>

                <option-list>
                    <option id="output" name="Output">
                        <summary>Output type.</summary>

                        <text>
                            <p>The following output formats are supported:</p>
                            <list>
                                <list-item><id>text</id> - Display the installed <backrest/> version as text.</list-item>
                                <list-item><id>num</id> - Display the installed <backrest/> version as an integer.</list-item>
                            </list>
                        </text>

                        <example>num</example>
                    </option>
                </option-list>
            </command>
        </command-list>
    </operation>
</doc>
