remove non ascii whitespaces
This commit is contained in:
parent
598a10bc28
commit
5a6d6c4d13
GPG key ID:
901B2ADDF27C2263
117 changed files with 1928 additions and 1928 deletions
|
|
@ -16,12 +16,12 @@ All Borg commands share these options:
|
|||
|
||||
| Option | Description |
|
||||
| ----------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `--info, -v, --verbose` | work on log level INFO |
|
||||
| `-p, --progress` | show progress information |
|
||||
| `--info, -v, --verbose` | work on log level INFO |
|
||||
| `-p, --progress` | show progress information |
|
||||
| `--log-json` | Output one [JSON](../../files/JSON.md) object per log line instead of formatted text. |
|
||||
| `--bypass-lock` | Bypass locking mechanism |
|
||||
| `--remote-path PATH` | use PATH as borg executable on the remote (default: “borg”) |
|
||||
| `--rsh RSH` | Use this command to connect to the ‘borg serve’ process (default: ‘ssh’) |
|
||||
| `--remote-path PATH` | use PATH as borg executable on the remote (default: “borg”) |
|
||||
| `--rsh RSH` | Use this command to connect to the ‘borg serve’ process (default: ‘ssh’) |
|
||||
|
||||
### `borg init`
|
||||
This command initializes an empty repository. A repository is a filesystem directory containing the deduplicated data from zero or more archives.
|
||||
|
|
@ -31,7 +31,7 @@ Usage: `borg [common options] init [options] [REPOSITORY]`
|
|||
|
||||
| Option | Description |
|
||||
| ------------------------------ | ----------------------------------------- |
|
||||
| `-e MODE`, `--encryption MODE` | select encryption key mode **(required)** |
|
||||
| `-e MODE`, `--encryption MODE` | select encryption key mode **(required)** |
|
||||
|
||||
#### Examples
|
||||
```shell
|
||||
|
|
@ -57,31 +57,31 @@ Usage: `borg [common options] create [options] ARCHIVE [PATH...]`
|
|||
#### Options
|
||||
| Option | Description |
|
||||
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ` -n`, `--dry-run` | do not create a backup archive |
|
||||
| `-s`, `--stats` | print statistics for the created archive |
|
||||
| ` -n`, `--dry-run` | do not create a backup archive |
|
||||
| `-s`, `--stats` | print statistics for the created archive |
|
||||
| `--list` | output verbose list of items (files, dirs, …) |
|
||||
| `--json` | output stats as JSON. Implies `--stats`. |
|
||||
| `--stdin-name NAME` | use NAME in archive for stdin data (default: `stdin`) |
|
||||
| `--stdin-user USER` | set user USER in archive for stdin data (default: `root`) |
|
||||
| `--stdin-group GROUP` | set group GROUP in archive for stdin data (default: `wheel`) |
|
||||
| `--stdin-mode M` | set mode to M in archive for stdin data (default: 0660) |
|
||||
| `--json` | output stats as JSON. Implies `--stats`. |
|
||||
| `--stdin-name NAME` | use NAME in archive for stdin data (default: `stdin`) |
|
||||
| `--stdin-user USER` | set user USER in archive for stdin data (default: `root`) |
|
||||
| `--stdin-group GROUP` | set group GROUP in archive for stdin data (default: `wheel`) |
|
||||
| `--stdin-mode M` | set mode to M in archive for stdin data (default: 0660) |
|
||||
| `--content-from-command` | interpret PATH as command and store its stdout. |
|
||||
| `--paths-from-stdin` | read DELIM-separated list of paths to backup from stdin. All control is external: it will back up all files given - no more, no less. |
|
||||
| `--paths-from-command` | interpret PATH as command and treat its output as `--paths-from-stdin` |
|
||||
| `--paths-delimiter DELIM` | set path delimiter for `--paths-from-stdin` and `--paths-from-command` (default: `\n`) |
|
||||
| `-e PATTERN`, `--exclude PATTERN` | exclude paths matching PATTERN |
|
||||
| `--exclude-from EXCLUDEFILE` | read exclude patterns from EXCLUDEFILE, one per line |
|
||||
| `--pattern PATTERN` | include/exclude paths matching PATTERN |
|
||||
| `--patterns-from PATTERNFILE` | read include/exclude patterns from PATTERNFILE, one per line |
|
||||
| `--paths-from-command` | interpret PATH as command and treat its output as `--paths-from-stdin` |
|
||||
| `--paths-delimiter DELIM` | set path delimiter for `--paths-from-stdin` and `--paths-from-command` (default: `\n`) |
|
||||
| `-e PATTERN`, `--exclude PATTERN` | exclude paths matching PATTERN |
|
||||
| `--exclude-from EXCLUDEFILE` | read exclude patterns from EXCLUDEFILE, one per line |
|
||||
| `--pattern PATTERN` | include/exclude paths matching PATTERN |
|
||||
| `--patterns-from PATTERNFILE` | read include/exclude patterns from PATTERNFILE, one per line |
|
||||
| `--exclude-caches` | exclude directories that contain a CACHEDIR.TAG file |
|
||||
| `--exclude-if-present NAME` | exclude directories that are tagged by containing a filesystem object with the given NAME |
|
||||
| `--keep-exclude-tags` | if tag objects are specified with `--exclude-if-present`, don’t omit the tag objects themselves from the backup archive |
|
||||
| `--exclude-if-present NAME` | exclude directories that are tagged by containing a filesystem object with the given NAME |
|
||||
| `--keep-exclude-tags` | if tag objects are specified with `--exclude-if-present`, don’t omit the tag objects themselves from the backup archive |
|
||||
| `--exclude-nodump` | exclude files flagged NODUMP |
|
||||
| `-x`, `--one-file-system` | stay in the same file system and do not store mount points of other file systems |
|
||||
| `--comment COMMENT` | add a comment text to the archive |
|
||||
| `--timestamp TIMESTAMP` | manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). Alternatively, give a reference file/directory. |
|
||||
| `-c SECONDS`, `--checkpoint-interval SECONDS` | write checkpoint every SECONDS seconds (Default: 1800) |
|
||||
| `-C COMPRESSION`, `--compression COMPRESSION` | select compression algorithm, see the output of the “borg help compression” command for details. |
|
||||
| `-x`, `--one-file-system` | stay in the same file system and do not store mount points of other file systems |
|
||||
| `--comment COMMENT` | add a comment text to the archive |
|
||||
| `--timestamp TIMESTAMP` | manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). Alternatively, give a reference file/directory. |
|
||||
| `-c SECONDS`, `--checkpoint-interval SECONDS` | write checkpoint every SECONDS seconds (Default: 1800) |
|
||||
| `-C COMPRESSION`, `--compression COMPRESSION` | select compression algorithm, see the output of the “borg help compression” command for details. |
|
||||
|
||||
#### Examples
|
||||
```shell
|
||||
|
|
@ -158,19 +158,19 @@ $ borg create /path/to/repo::daily-projectA-{now:%Y-%m-%d} projectA
|
|||
```
|
||||
|
||||
### `borg extract`
|
||||
This command extracts the contents of an archive. By default the entire archive is extracted but a subset of files and directories can be selected by passing a list of `PATHs` as arguments. The file selection can further be restricted by using the `--exclude` option.
|
||||
This command extracts the contents of an archive. By default the entire archive is extracted but a subset of files and directories can be selected by passing a list of `PATHs` as arguments. The file selection can further be restricted by using the `--exclude` option.
|
||||
Usage: `borg [common options] extract [options] ARCHIVE [PATH...]`
|
||||
|
||||
#### Options
|
||||
| Option | Description |
|
||||
| --------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `--list` | output verbose list of items (files, dirs, …) |
|
||||
| `-n`, `--dry-run` | do not actually change any files |
|
||||
| `-e PATTERN`, `--exclude PATTERN` | exclude paths matching PATTERN |
|
||||
| `--exclude-from EXCLUDEFILE` | read exclude patterns from EXCLUDEFILE, one per line |
|
||||
| `--pattern PATTERN` | include/exclude paths matching PATTERN |
|
||||
| `--patterns-from PATTERNFILE` | read include/exclude patterns from PATTERNFILE, one per line |
|
||||
| `--strip-components NUMBER` | Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped. |
|
||||
| `-n`, `--dry-run` | do not actually change any files |
|
||||
| `-e PATTERN`, `--exclude PATTERN` | exclude paths matching PATTERN |
|
||||
| `--exclude-from EXCLUDEFILE` | read exclude patterns from EXCLUDEFILE, one per line |
|
||||
| `--pattern PATTERN` | include/exclude paths matching PATTERN |
|
||||
| `--patterns-from PATTERNFILE` | read include/exclude patterns from PATTERNFILE, one per line |
|
||||
| `--strip-components NUMBER` | Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped. |
|
||||
|
||||
#### Examples
|
||||
```shell
|
||||
|
|
@ -203,10 +203,10 @@ Usage: `borg [common options] check [options] [REPOSITORY_OR_ARCHIVE]`
|
|||
| ------------------------ | ---------------------------------------------------------------------------------------------- |
|
||||
| `--repository-only` | only perform repository checks |
|
||||
| `--archives-only` | only perform archives checks |
|
||||
| `--verify-data` | perform cryptographic archive data integrity verification (conflicts with `--repository-only`) |
|
||||
| `--verify-data` | perform cryptographic archive data integrity verification (conflicts with `--repository-only`) |
|
||||
| `--repair` | attempt to repair any inconsistencies found |
|
||||
| `--save-space` | work slower, but using less space |
|
||||
| `--max-duration SECONDS` | do only a partial repo check for max. SECONDS seconds (Default: unlimited) |
|
||||
| `--max-duration SECONDS` | do only a partial repo check for max. SECONDS seconds (Default: unlimited) |
|
||||
|
||||
### `borg rename`
|
||||
This command renames an archive in the repository.
|
||||
|
|
@ -232,18 +232,18 @@ Usage: `borg [common options] list [options] [REPOSITORY_OR_ARCHIVE] [PATH...]`
|
|||
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `--consider-checkpoints` | Show checkpoint archives in the repository contents list (default: hidden). |
|
||||
| `--short` | only print file/directory names, nothing else |
|
||||
| `--format FORMAT` | specify format for file or archive listing (default for files: `{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}`; for archives: `{archive:<36} {time} [{id}]{NL}`) |
|
||||
| `--json` | Only valid for listing repository contents. Format output as [JSON](../../files/JSON.md). The form of `--format` is ignored, but keys used in it are added to the [JSON](../../files/JSON.md) output. Some keys are always present. Note: [JSON](../../files/JSON.md) can only represent text. A “barchive” key is therefore not available. |
|
||||
| `--json-lines` | Only valid for listing archive contents. Format output as [JSON](../../files/JSON.md) Lines. The form of `--format` is ignored, but keys used in it are added to the [JSON](../../files/JSON.md) output. Some keys are always present. Note: [JSON](../../files/JSON.md) can only represent text. A “bpath” key is therefore not available. |
|
||||
| `-P PREFIX`, `--prefix PREFIX` | only consider archive names starting with this prefix. (deprecated) |
|
||||
| `-a GLOB`, `--glob-archives GLOB` | only consider archive names matching the glob. sh: rules apply (without actually using the sh: prefix), see “borg help patterns”. |
|
||||
| `--sort-by KEYS` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp |
|
||||
| `--first N` | consider first N archives after other filters were applied |
|
||||
| `--last N` | consider last N archives after other filters were applied |
|
||||
| `-e PATTERN`, `--exclude PATTERN` | exclude paths matching PATTERN |
|
||||
| `--exclude-from EXCLUDEFILE` | read exclude patterns from EXCLUDEFILE, one per line |
|
||||
| `--pattern PATTERN` | include/exclude paths matching PATTERN |
|
||||
| `--patterns-from PATTERNFILE` | read include/exclude patterns from PATTERNFILE, one per line |
|
||||
| `--format FORMAT` | specify format for file or archive listing (default for files: `{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}`; for archives: `{archive:<36} {time} [{id}]{NL}`) |
|
||||
| `--json` | Only valid for listing repository contents. Format output as [JSON](../../files/JSON.md). The form of `--format` is ignored, but keys used in it are added to the [JSON](../../files/JSON.md) output. Some keys are always present. Note: [JSON](../../files/JSON.md) can only represent text. A “barchive” key is therefore not available. |
|
||||
| `--json-lines` | Only valid for listing archive contents. Format output as [JSON](../../files/JSON.md) Lines. The form of `--format` is ignored, but keys used in it are added to the [JSON](../../files/JSON.md) output. Some keys are always present. Note: [JSON](../../files/JSON.md) can only represent text. A “bpath” key is therefore not available. |
|
||||
| `-P PREFIX`, `--prefix PREFIX` | only consider archive names starting with this prefix. (deprecated) |
|
||||
| `-a GLOB`, `--glob-archives GLOB` | only consider archive names matching the glob. sh: rules apply (without actually using the sh: prefix), see “borg help patterns”. |
|
||||
| `--sort-by KEYS` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp |
|
||||
| `--first N` | consider first N archives after other filters were applied |
|
||||
| `--last N` | consider last N archives after other filters were applied |
|
||||
| `-e PATTERN`, `--exclude PATTERN` | exclude paths matching PATTERN |
|
||||
| `--exclude-from EXCLUDEFILE` | read exclude patterns from EXCLUDEFILE, one per line |
|
||||
| `--pattern PATTERN` | include/exclude paths matching PATTERN |
|
||||
| `--patterns-from PATTERNFILE` | read include/exclude patterns from PATTERNFILE, one per line |
|
||||
|
||||
#### Examples
|
||||
```shell
|
||||
|
|
@ -313,9 +313,9 @@ Usage: `borg [common options] delete [options] [REPOSITORY_OR_ARCHIVE] [ARCHIVE.
|
|||
#### Options
|
||||
| Option | Description |
|
||||
| ----------------- | ---------------------------------------- |
|
||||
| `-n`, `--dry-run` | do not change repository |
|
||||
| `-n`, `--dry-run` | do not change repository |
|
||||
| `--list` | output verbose list of archives |
|
||||
| `-s`, `--stats` | print statistics for the deleted archive |
|
||||
| `-s`, `--stats` | print statistics for the deleted archive |
|
||||
|
||||
#### Examples
|
||||
```shell
|
||||
|
|
@ -341,18 +341,18 @@ Usage: `borg [common options] prune [options] [REPOSITORY]`
|
|||
#### Options
|
||||
| Option | Description |
|
||||
| -------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `-n`, `--dry-run` | do not change repository |
|
||||
| `--force` | force pruning of corrupted archives, use `--force --force` in case `--force` does not work. |
|
||||
| `-s`, `--stats` | print statistics for the deleted archive |
|
||||
| `-n`, `--dry-run` | do not change repository |
|
||||
| `--force` | force pruning of corrupted archives, use `--force --force` in case `--force` does not work. |
|
||||
| `-s`, `--stats` | print statistics for the deleted archive |
|
||||
| `--list` | output verbose list of archives it keeps/prunes |
|
||||
| `--keep-within INTERVAL` | keep all archives within this time interval |
|
||||
| `--keep-last`, `--keep-secondly` | number of secondly archives to keep |
|
||||
| `--keep-within INTERVAL` | keep all archives within this time interval |
|
||||
| `--keep-last`, `--keep-secondly` | number of secondly archives to keep |
|
||||
| `--keep-minutely` | number of minutely archives to keep |
|
||||
| `-H`, `--keep-hourly` | number of hourly archives to keep |
|
||||
| `-d`, `--keep-daily` | number of daily archives to keep |
|
||||
| `-w`, `--keep-weekly` | number of weekly archives to keep |
|
||||
| `-m`, `--keep-monthly` | number of monthly archives to keep |
|
||||
| `-y`, `--keep-yearly` | number of yearly archives to keep |
|
||||
| `-H`, `--keep-hourly` | number of hourly archives to keep |
|
||||
| `-d`, `--keep-daily` | number of daily archives to keep |
|
||||
| `-w`, `--keep-weekly` | number of weekly archives to keep |
|
||||
| `-m`, `--keep-monthly` | number of monthly archives to keep |
|
||||
| `-y`, `--keep-yearly` | number of yearly archives to keep |
|
||||
|
||||
#### Examples
|
||||
```shell
|
||||
|
|
@ -398,13 +398,13 @@ Usage: `borg [common options] info [options] [REPOSITORY_OR_ARCHIVE]`
|
|||
| `--json` | format output as JSON |
|
||||
|
||||
### `borg mount`
|
||||
This command mounts an archive as a FUSE filesystem. This can be useful for browsing an archive or restoring individual files. Unless the `--foreground` option is given the command will run in the background until the filesystem is `umounted`.
|
||||
This command mounts an archive as a FUSE filesystem. This can be useful for browsing an archive or restoring individual files. Unless the `--foreground` option is given the command will run in the background until the filesystem is `umounted`.
|
||||
Usage: `borg [common options] mount [options] REPOSITORY_OR_ARCHIVE MOUNTPOINT [PATH...]`
|
||||
|
||||
#### Options
|
||||
| Option | Description |
|
||||
| -------------------- | ------------------------------------------------------ |
|
||||
| `-f`, `--foreground` | stay in foreground, do not daemonize |
|
||||
| `-f`, `--foreground` | stay in foreground, do not daemonize |
|
||||
| `-o` | Extra mount options |
|
||||
| `--numeric-ids` | use numeric user and group identifiers from archive(s) |
|
||||
|
||||
|
|
@ -427,7 +427,7 @@ $ borg umount /tmp/mymountpoint
|
|||
```
|
||||
|
||||
### `borg unmount`
|
||||
This command un-mounts a FUSE filesystem that was mounted with `borg mount`.
|
||||
This command un-mounts a FUSE filesystem that was mounted with `borg mount`.
|
||||
Usage: `borg [common options] umount [options] MOUNTPOINT`
|
||||
|
||||
### `borg key change-passphrase`
|
||||
|
|
@ -441,5 +441,5 @@ Usage: `borg [common options] serve [options]`
|
|||
#### Options
|
||||
| Option | Description |
|
||||
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `--restrict-to-path PATH` | restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn’t need to directly point to a repository. |
|
||||
| `--restrict-to-repository PATH` | restrict repository access. Only the repository located at PATH (no sub-directories are considered) is accessible. Can be specified multiple times to allow the client access to several repositories. Unlike `--restrict-to-path` sub-directories are not accessible; PATH needs to directly point at a repository location. PATH may be an empty directory or the last element of PATH may not exist, in which case the client may initialize a repository there. |
|
||||
| `--restrict-to-path PATH` | restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn’t need to directly point to a repository. |
|
||||
| `--restrict-to-repository PATH` | restrict repository access. Only the repository located at PATH (no sub-directories are considered) is accessible. Can be specified multiple times to allow the client access to several repositories. Unlike `--restrict-to-path` sub-directories are not accessible; PATH needs to directly point at a repository location. PATH may be an empty directory or the last element of PATH may not exist, in which case the client may initialize a repository there. |
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue