mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

minor typos/trailing spaces fixes in git-annex.mdwn

Browse source
This commit is contained in:
Yaroslav Halchenko 2013-12-04 01:10:18 -05:00 committed by Joey Hess
parent 71faabe278
commit 9639142df9
1 changed files with 26 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
doc/git-annex.mdwn
View file

@ -135,7 +135,7 @@ subdirectories).
* `sync [remote ...]` * `sync [remote ...]`
Use this command when you want to synchronize the local repository with Use this command when you want to synchronize the local repository with
one or more of its remotes. You can specifiy the remotes to sync with; one or more of its remotes. You can specify the remotes to sync with;
the default is to sync with all remotes. Or specify `--fast` to sync with the default is to sync with all remotes. Or specify `--fast` to sync with
the remotes with the lowest annex-cost value. the remotes with the lowest annex-cost value.
@ -169,7 +169,7 @@ subdirectories).
copy automatically. copy automatically.
* `mirror [path ...]` * `mirror [path ...]`
This causes a destination repository to mirror a source repository. This causes a destination repository to mirror a source repository.
To use the local repository as the source repository, To use the local repository as the source repository,
@ -181,7 +181,7 @@ subdirectories).
repository. If a file's content is present in the source repository, it is repository. If a file's content is present in the source repository, it is
copied to the destination repository. If a file's content is not present in copied to the destination repository. If a file's content is not present in
the source repository, it will be dropped from the destination repository the source repository, it will be dropped from the destination repository
when possible. when possible.
Note that mirror does not sync the git repository, but only the file Note that mirror does not sync the git repository, but only the file
contents. contents.
@ -235,11 +235,11 @@ subdirectories).
To only import files whose content has not been seen before by git-annex, To only import files whose content has not been seen before by git-annex,
use the `--deduplicate` option. Duplicate files will be deleted from the use the `--deduplicate` option. Duplicate files will be deleted from the
import location. import location.
The `--clean-duplicates` option does not import any new files, but any files The `--clean-duplicates` option does not import any new files, but any files
found in the import location that are duplicates of content in the annex found in the import location that are duplicates of content in the annex
are deleted. are deleted.
(Note that using `--deduplicate` or `--clean-duplicates` with the WORM (Note that using `--deduplicate` or `--clean-duplicates` with the WORM
backend does not look at file content, but filename and mtime.) backend does not look at file content, but filename and mtime.)
@ -267,7 +267,7 @@ subdirectories).
By default, all files in the directory will be added to the repository. By default, all files in the directory will be added to the repository.
(Including dotfiles.) To block some files from being added, use (Including dotfiles.) To block some files from being added, use
`.gitignore` files. `.gitignore` files.
By default, all files that are added are added to the annex, the same By default, all files that are added are added to the annex, the same
as when you run `git annex add`. If you configure annex.largefiles, as when you run `git annex add`. If you configure annex.largefiles,
files that it does not match will instead be added with `git add`. files that it does not match will instead be added with `git add`.
@ -302,7 +302,7 @@ subdirectories).
* `init [description]` * `init [description]`
Until a repository (or one of its remotes) has been initialized, Until a repository (or one of its remotes) has been initialized,
git-annex will refuse to operate on it, to avoid accidentially git-annex will refuse to operate on it, to avoid accidentally
using it in a repository that was not intended to have an annex. using it in a repository that was not intended to have an annex.
It's useful, but not mandatory, to initialize each new clone It's useful, but not mandatory, to initialize each new clone
@ -326,23 +326,23 @@ subdirectories).
command will prompt for parameters as needed. command will prompt for parameters as needed.
All special remotes support encryption. You can either specify All special remotes support encryption. You can either specify
`encryption=none` to disable encryption, or specify `encryption=none` to disable encryption, or specify
`encryption=hybrid keyid=$keyid ...` to specify a gpg key id (or an email `encryption=hybrid keyid=$keyid ...` to specify a GPG key id (or an email
address associated with a key.) address associated with a key.)
There are actually three schemes that can be used for management of the There are actually three schemes that can be used for management of the
encryption keys. When using the encryption=hybrid scheme, additional encryption keys. When using the encryption=hybrid scheme, additional
gpg keys can be given access to the encrypted special remote easily GPG keys can be given access to the encrypted special remote easily
(without re-encrypting everything). When using encryption=shared, (without re-encrypting everything). When using encryption=shared,
a shared key is generated and stored in the git repository, allowing a shared key is generated and stored in the git repository, allowing
anyone who can clone the git repository to access it. Finally, when using anyone who can clone the git repository to access it. Finally, when using
encryption=pubkey, content in the special remote is directly encrypted encryption=pubkey, content in the special remote is directly encrypted
to the specified gpg keys, and additional ones cannot easily be given to the specified GPG keys, and additional ones cannot easily be given
access. access.
Note that with encryption enabled, a cryptographic key is created. Note that with encryption enabled, a cryptographic key is created.
This requires sufficient entropy. If initremote seems to hang or take This requires sufficient entropy. If initremote seems to hang or take
a long time while generating the key, you may want to ctrl-c it and a long time while generating the key, you may want to Ctrl-c it and
re-run with `--fast`, which causes it to use a lower-quality source of re-run with `--fast`, which causes it to use a lower-quality source of
randomness. randomness.
@ -354,7 +354,7 @@ subdirectories).
Enables use of an existing special remote in the current repository, Enables use of an existing special remote in the current repository,
which may be a different repository than the one in which it was which may be a different repository than the one in which it was
originally created with the initremote command. originally created with the initremote command.
The name of the remote is the same name used when origianlly The name of the remote is the same name used when origianlly
creating that remote with "initremote". Run "git annex enableremote" creating that remote with "initremote". Run "git annex enableremote"
@ -369,7 +369,7 @@ subdirectories).
the as the encryption scheme cannot be changed once a special remote the as the encryption scheme cannot be changed once a special remote
has been created.) has been created.)
The gpg keys that an encrypted special remote is encrypted to can be The GPG keys that an encrypted special remote is encrypted to can be
changed using the keyid+= and keyid-= parameters. These respectively changed using the keyid+= and keyid-= parameters. These respectively
add and remove keys from the list. However, note that removing a key add and remove keys from the list. However, note that removing a key
does NOT necessarily prevent the key's owner from accessing data does NOT necessarily prevent the key's owner from accessing data
@ -539,30 +539,30 @@ subdirectories).
data about past locations of files. The resulting branch will use less data about past locations of files. The resulting branch will use less
space, but `git annex log` will not be able to show where space, but `git annex log` will not be able to show where
files used to be located. files used to be located.
To also prune references to repositories that have been marked as dead, To also prune references to repositories that have been marked as dead,
specify `--drop-dead`. specify `--drop-dead`.
When this rewritten branch is merged into other clones of When this rewritten branch is merged into other clones of
the repository, `git-annex` will automatically perform the same rewriting the repository, `git-annex` will automatically perform the same rewriting
to their local `git-annex` branches. So the forgetfulness will automatically to their local `git-annex` branches. So the forgetfulness will automatically
propigate out from its starting point until all repositories running propagate out from its starting point until all repositories running
git-annex have forgotten their old history. (You may need to force git-annex have forgotten their old history. (You may need to force
git to push the branch to any git repositories not running git-annex.) git to push the branch to any git repositories not running git-annex.)
* `repair` * `repair`
This can repair many of the problems with git repositories that `git fsck` This can repair many of the problems with git repositories that `git fsck`
detects, but does not itself fix. It's useful if a repository has become detects, but does not itself fix. It's useful if a repository has become
badly damaged. One way this can happen is if a repisitory used by git-annex badly damaged. One way this can happen is if a repository used by git-annex
is on a removable drive that gets unplugged at the wrong time. is on a removable drive that gets unplugged at the wrong time.
This command can actually be used inside git repositories that do not This command can actually be used inside git repositories that do not
use git-annex at all; when used in a repository using git-annex, it use git-annex at all; when used in a repository using git-annex, it
does additional repairs of the git-annex branch. does additional repairs of the git-annex branch.
It works by deleting any corrupt objects from the git repository, and It works by deleting any corrupt objects from the git repository, and
retriving all missing objects it can from the remotes of the repository. retrieving all missing objects it can from the remotes of the repository.
If that is not sufficient to fully recover the repository, it can also If that is not sufficient to fully recover the repository, it can also
reset branches back to commits before the corruption happened, delete reset branches back to commits before the corruption happened, delete
@ -616,7 +616,7 @@ subdirectories).
Displays the location log for the specified file or files, Displays the location log for the specified file or files,
showing each repository they were added to ("+") and removed from ("-"). showing each repository they were added to ("+") and removed from ("-").
To limit how far back to seach for location log changes, the options To limit how far back to search for location log changes, the options
`--since`, `--after`, `--until`, `--before`, and `--max-count` can be specified. `--since`, `--after`, `--until`, `--before`, and `--max-count` can be specified.
They are passed through to git log. For example, `--since "1 month ago"` They are passed through to git log. For example, `--since "1 month ago"`
@ -1032,7 +1032,7 @@ no equivilant to `--in`.
When a repository is in one of the standard predefined groups, like "backup" When a repository is in one of the standard predefined groups, like "backup"
and "client", setting its preferred content to "standard" will use a and "client", setting its preferred content to "standard" will use a
built-in preferred content expression ddeveloped for that group. built-in preferred content expression developed for that group.
# SCHEDULED JOBS # SCHEDULED JOBS
@ -1070,13 +1070,13 @@ Here are all the supported configuration settings.
* `annex.numcopies` * `annex.numcopies`
Number of copies of files to keep across all repositories. (default: 1) Number of copies of files to keep across all repositories. (default: 1)
Note that setting numcopies to 0 is very unsafe. Note that setting numcopies to 0 is very unsafe.
* `annex.backends` * `annex.backends`
Space-separated list of names of the key-value backends to use. Space-separated list of names of the key-value backends to use.
The first listed is used to store new files by default. The first listed is used to store new files by default.
* `annex.diskreserve` * `annex.diskreserve`
@ -1160,7 +1160,7 @@ Here are all the supported configuration settings.
Note that upgrade checking is only done when git-annex is installed Note that upgrade checking is only done when git-annex is installed
from one of the prebuilt images from its website. This does not from one of the prebuilt images from its website. This does not
bypass eg, a Linux distribution's own upgrade handling code. bypass e.g., a Linux distribution's own upgrade handling code.
This setting also controls whether to restart the git-annex assistant This setting also controls whether to restart the git-annex assistant
when the git-annex binary is detected to have changed. That is useful when the git-annex binary is detected to have changed. That is useful