Skip to content

Commit

Permalink
ran build_api / build_usage
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasWaldmann committed Jul 7, 2016
1 parent a4603cf commit 3218c59
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 42 deletions.
4 changes: 0 additions & 4 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,6 @@ API Documentation
:members:
:undoc-members:

.. automodule:: borg.hash_sizes
:members:
:undoc-members:

.. automodule:: borg.xattr
:members:
:undoc-members:
Expand Down
76 changes: 38 additions & 38 deletions docs/usage/help.rst.inc
Original file line number Diff line number Diff line change
@@ -1,5 +1,43 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_placeholders:
borg help placeholders
~~~~~~~~~~~~~~~~~~~~~~
::
Repository (or Archive) URLs and --prefix values support these placeholders:
{hostname}
The (short) hostname of the machine.
{fqdn}
The full name of the machine.
{now}
The current local date and time.
{utcnow}
The current UTC date and time.
{user}
The user name (or UID, if no name is available) of the user running borg.
{pid}
The current process ID.
Examples::
borg create /path/to/repo::{hostname}-{user}-{utcnow} ...
borg create /path/to/repo::{hostname}-{now:%Y-%m-%d_%H:%M:%S} ...
borg prune --prefix '{hostname}-' ...
.. _borg_patterns:
borg help patterns
Expand Down Expand Up @@ -93,41 +131,3 @@ Examples::
sh:/home/*/.thumbnails
EOF
$ borg create --exclude-from exclude.txt backup /
.. _borg_placeholders:

borg help placeholders
~~~~~~~~~~~~~~~~~~~~~~
::


Repository (or Archive) URLs and --prefix values support these placeholders:

{hostname}

The (short) hostname of the machine.

{fqdn}

The full name of the machine.

{now}

The current local date and time.

{utcnow}

The current UTC date and time.

{user}

The user name (or UID, if no name is available) of the user running borg.

{pid}

The current process ID.

Examples::

borg create /path/to/repo::{hostname}-{user}-{utcnow} ...
borg create /path/to/repo::{hostname}-{now:%Y-%m-%d_%H:%M:%S} ...
borg prune --prefix '{hostname}-' ...

0 comments on commit 3218c59

Please sign in to comment.