db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2026-05-22 10:15:16 +02:00
Code Issues Releases Activity

Add internal flag for commands.

Browse Source 
Allow commands to be skipped by default in the command help but still work if help is requested for the command directly.  There may be other uses for the flag in the future.

Update help for ls now that it is exposed.
This commit is contained in:
David Steele
2019-05-28 12:18:05 -04:00
parent 20e5b92f36
commit 404284b90f
10 changed files with 124 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/xml/reference.xml
+27 -3
View File
@@ -1218,16 +1218,40 @@
</command-example-list>
</command>
<!-- OPERATION - STORAGE-LIST COMMAND -->
<command id="storage-list" name="Storage List">
<!-- OPERATION - LS COMMAND -->
<command id="ls" name="Storage List">
<summary>List paths/files in the repository.</summary>
<text>This is intended to be a general purpose list function, but for now it only works on the repository.</text>
<option-list>
<!-- OPERATION - LS COMMAND - FILTER OPTION -->
<option id="filter" name="Filter Output">
<summary>Filter output with a regular expression.</summary>
<text>The filter is applied against the file/path names before they are output.</text>
<example>(F|D|I)$</example>
</option>
<!-- OPERATION - LS COMMAND - SORT OPTION -->
<option id="sort" name="Sort Output">
<summary>Sort output ascending/descending.</summary>
<text>The following sort types are supported:
<ul>
<li><id>asc</id> - sort ascending.</li>
<li><id>desc</id> - sort descending.</li>
</ul></text>
<example>desc</example>
</option>
</option-list>
<command-example-list>
<command-example title="List all backups in a stanza">
<text><code-block title="">
{[backrest-exe]} storage-list backup/demo
{[backrest-exe]} ls backup/demo
</code-block>
List all backups in the demo stanza.</text>