2023-07-02 02:46:54 +00:00
|
|
|
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
|
|
|
|
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
|
|
|
<channel>
|
|
|
|
<title>Backy on A tool for commands</title>
|
|
|
|
<link>http://example.org/index.html</link>
|
|
|
|
<description>Recent content in Backy on A tool for commands</description>
|
|
|
|
<generator>Hugo -- gohugo.io</generator>
|
|
|
|
<language>en-us</language><atom:link href="http://example.org/index.xml" rel="self" type="application/rss+xml" />
|
|
|
|
<item>
|
|
|
|
<title>Getting started</title>
|
|
|
|
<link>http://example.org/getting-started/index.html</link>
|
|
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
|
|
<guid>http://example.org/getting-started/index.html</guid>
|
2024-11-20 06:08:16 +00:00
|
|
|
<description><p>If you have not installed Backy, <a href="install">see the install documentation</a>.</p>
|
|
|
|
<p>If you need to configure it, <a href="config">see the config page</a>.</p></description>
|
2023-07-02 02:46:54 +00:00
|
|
|
</item>
|
|
|
|
<item>
|
|
|
|
<title>Configuring Backy</title>
|
|
|
|
<link>http://example.org/config/index.html</link>
|
|
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
|
|
<guid>http://example.org/config/index.html</guid>
|
2024-11-20 06:08:16 +00:00
|
|
|
<description><p>This is the section on the config file.</p>
|
|
|
|
<p>To use a specific file:
|
|
|
|
<code>backy [command] -f /path/to/file</code></p>
|
|
|
|
<p>If you leave the config path blank, the following paths will be searched in order:</p>
|
|
|
|
<ol>
|
|
|
|
<li><code>./backy.yml</code></li>
|
|
|
|
<li><code>./backy.yaml</code></li>
|
|
|
|
<li><code>~/.config/backy.yml</code></li>
|
|
|
|
<li><code>~/.config/backy.yaml</code></li>
|
|
|
|
</ol>
|
|
|
|
<p>Create a file at <code>~/.config/backy.yml</code>.</p>
|
|
|
|
<p>See the rest of the documentation in this section to configure it.</p></description>
|
2023-07-02 02:46:54 +00:00
|
|
|
</item>
|
|
|
|
<item>
|
|
|
|
<title>CLI</title>
|
|
|
|
<link>http://example.org/cli/index.html</link>
|
|
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
|
|
<guid>http://example.org/cli/index.html</guid>
|
2024-11-20 06:08:16 +00:00
|
|
|
<description><p>This page lists documentation for the CLI.</p>
|
|
|
|
<h2 id="backy">Backy</h2>
|
|
|
|
<pre tabindex="0"><code>Backy is a command-line application useful for configuring backups, or any commands run in sequence.
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
backy [command]
|
|
|
|
|
|
|
|
Available Commands:
|
|
|
|
backup Runs commands defined in config file.
|
|
|
|
completion Generate the autocompletion script for the specified shell
|
|
|
|
cron Starts a scheduler that runs lists defined in config file.
|
|
|
|
exec Runs commands defined in config file in order given.
|
|
|
|
help Help about any command
|
|
|
|
list Lists commands, lists, or hosts defined in config file.
|
|
|
|
version Prints the version and exits
|
|
|
|
|
|
|
|
Flags:
|
|
|
|
-f, --config string config file to read from
|
|
|
|
-h, --help help for backy
|
|
|
|
-v, --verbose Sets verbose level
|
|
|
|
|
|
|
|
Use &#34;backy [command] --help&#34; for more information about a command.
|
|
|
|
</code></pre><h1 id="subcommands">Subcommands</h1>
|
|
|
|
<h2 id="backup">backup</h2>
|
|
|
|
<pre tabindex="0"><code>Backup executes commands defined in config file.
|
|
|
|
Use the --lists or -l flag to execute the specified lists. If not flag is not given, all lists will be executed.
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
backy backup [--lists=list1,list2,... | -l list1, list2,...] [flags]
|
|
|
|
|
|
|
|
Flags:
|
|
|
|
-h, --help help for backup
|
|
|
|
-l, --lists strings Accepts comma-separated names of command lists to execute.
|
|
|
|
|
|
|
|
Global Flags:
|
|
|
|
-f, --config string config file to read from
|
|
|
|
-v, --verbose Sets verbose level
|
|
|
|
</code></pre><h2 id="cron">cron</h2>
|
|
|
|
<pre tabindex="0"><code>Cron starts a scheduler that executes command lists at the time defined in config file.
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
backy cron [flags]
|
|
|
|
|
|
|
|
Flags:
|
|
|
|
-h, --help help for cron
|
|
|
|
|
|
|
|
Global Flags:
|
|
|
|
-f, --config string config file to read from
|
|
|
|
-v, --verbose Sets verbose level
|
|
|
|
</code></pre><h2 id="exec">exec</h2>
|
|
|
|
<pre tabindex="0"><code>Exec executes commands defined in config file in order given.
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
backy exec command ... [flags]
|
|
|
|
|
|
|
|
Flags:
|
|
|
|
-h, --help help for exec
|
|
|
|
|
|
|
|
Global Flags:
|
|
|
|
-f, --config string config file to read from
|
|
|
|
-v, --verbose Sets verbose level
|
|
|
|
</code></pre><h2 id="version">version</h2>
|
|
|
|
<pre tabindex="0"><code>Prints the version and exits. No arguments just prints the version number only.
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
backy version [flags]
|
|
|
|
|
|
|
|
Flags:
|
|
|
|
-h, --help help for version
|
|
|
|
-n, --num Output the version number only.
|
|
|
|
-V, --vpre Output the version with v prefixed.
|
|
|
|
|
|
|
|
Global Flags:
|
|
|
|
-f, --config string config file to read from
|
|
|
|
-v, --verbose Sets verbose level
|
|
|
|
</code></pre><h2 id="list">list</h2>
|
|
|
|
<pre tabindex="0"><code>Backup lists commands or groups defined in config file.
|
|
|
|
Use the --lists or -l flag to list the specified lists. If not flag is not given, all lists will be executed.
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
backy list [--list=list1,list2,... | -l list1, list2,...] [ -cmd cmd1 cmd2 cmd3...] [flags]
|
|
|
|
|
|
|
|
Flags:
|
|
|
|
-c, --cmds strings Accepts comma-separated names of commands to list.
|
|
|
|
-h, --help help for list
|
|
|
|
-l, --lists strings Accepts comma-separated names of command lists to list.
|
|
|
|
|
|
|
|
Global Flags:
|
|
|
|
-f, --config string config file to read from
|
|
|
|
-v, --verbose Sets verbose level
|
|
|
|
</code></pre></description>
|
2023-07-02 02:46:54 +00:00
|
|
|
</item>
|
|
|
|
<item>
|
|
|
|
<title>Repositories</title>
|
|
|
|
<link>http://example.org/repositories/index.html</link>
|
|
|
|
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
|
|
|
<guid>http://example.org/repositories/index.html</guid>
|
2024-11-20 06:08:16 +00:00
|
|
|
<description><p>The repo mirrors are:</p>
|
|
|
|
<ul>
|
|
|
|
<li><a href="https://git.andrewnw.xyz/CyberShell/backy" target="_blank">https://git.andrewnw.xyz/CyberShell/backy</a></li>
|
|
|
|
<li><a href="https://github.com/CybersShell/backy" target="_blank">https://github.com/CybersShell/backy</a></li>
|
|
|
|
</ul></description>
|
2023-07-02 02:46:54 +00:00
|
|
|
</item>
|
|
|
|
</channel>
|
|
|
|
</rss>
|