Minor git-annex.mdwn tune ups (trailing spaces, typos, more consistency in tense)
Conflicts: doc/git-annex.mdwn -- I have managed to work on an old copy, so overlapped a bit
This commit is contained in:
parent
d793f20886
commit
0bf41b335b
1 changed files with 41 additions and 40 deletions
|
@ -112,12 +112,12 @@ subdirectories).
|
||||||
Similar to `git status --short`, displays the status of the files in the
|
Similar to `git status --short`, displays the status of the files in the
|
||||||
working tree. Shows files that are not checked into git, files that
|
working tree. Shows files that are not checked into git, files that
|
||||||
have been deleted, and files that have been modified.
|
have been deleted, and files that have been modified.
|
||||||
Particulary useful in direct mode.
|
Particularly useful in direct mode.
|
||||||
|
|
||||||
* `unlock [path ...]`
|
* `unlock [path ...]`
|
||||||
|
|
||||||
Normally, the content of annexed files is protected from being changed.
|
Normally, the content of annexed files is protected from being changed.
|
||||||
Unlocking a annexed file allows it to be modified. This replaces the
|
Unlocking an annexed file allows it to be modified. This replaces the
|
||||||
symlink for each specified file with a copy of the file's content.
|
symlink for each specified file with a copy of the file's content.
|
||||||
You can then modify it and `git annex add` (or `git commit`) to inject
|
You can then modify it and `git annex add` (or `git commit`) to inject
|
||||||
it back into the annex.
|
it back into the annex.
|
||||||
|
@ -139,21 +139,21 @@ subdirectories).
|
||||||
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.
|
||||||
|
|
||||||
The sync process involves first committing all local changes
|
The sync process involves first committing all local changes,
|
||||||
then fetching and merging the `synced/master` and the `git-annex` branch
|
then fetching and merging the `synced/master` and the `git-annex` branch
|
||||||
from the remote repositories and finally pushing the changes back to
|
from the remote repositories, and finally pushing the changes back to
|
||||||
those branches on the remote repositories. You can use standard git
|
those branches on the remote repositories. You can use standard git
|
||||||
commands to do each of those steps by hand, or if you don't want to
|
commands to do each of those steps by hand, or if you don't want to
|
||||||
worry about the details, you can use sync.
|
worry about the details, you can use sync.
|
||||||
|
|
||||||
Merge conflicts are automatically resolved by sync. When two conflicting
|
Merge conflicts are automatically handled by sync. When two conflicting
|
||||||
versions of a file have been committed, both will be added to the tree,
|
versions of a file have been committed, both will be added to the tree,
|
||||||
under different filenames. For example, file "foo" would be replaced
|
under different filenames. For example, file "foo" would be replaced
|
||||||
with "foo.somekey" and "foo.otherkey".
|
with "foo.somekey" and "foo.otherkey".
|
||||||
|
|
||||||
Note that syncing with a remote will not update the remote's working
|
Note that syncing with a remote will not update the remote's working
|
||||||
tree with changes made to the local repository. However, those changes
|
tree with changes made to the local repository. However, those changes
|
||||||
are pushed to the remote, so can be merged into its working tree
|
are pushed to the remote, so they can be merged into its working tree
|
||||||
by running "git annex sync" on the remote.
|
by running "git annex sync" on the remote.
|
||||||
|
|
||||||
Note that sync does not transfer any file contents from or to the remote
|
Note that sync does not transfer any file contents from or to the remote
|
||||||
|
@ -212,7 +212,7 @@ subdirectories).
|
||||||
addurl can be used both to add new files, or to add urls to existing files.
|
addurl can be used both to add new files, or to add urls to existing files.
|
||||||
|
|
||||||
When quvi is installed, urls are automatically tested to see if they
|
When quvi is installed, urls are automatically tested to see if they
|
||||||
are on a video hosting site, and the video is downloaded instead.
|
point to a video hosting site, and the video is downloaded instead.
|
||||||
|
|
||||||
* `rmurl file url`
|
* `rmurl file url`
|
||||||
|
|
||||||
|
@ -285,7 +285,7 @@ subdirectories).
|
||||||
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`.
|
||||||
|
|
||||||
To not daemonize, run with `--foreground` ; to stop a running daemon,
|
To not daemonize, run with `--foreground` ; to stop a running daemon,
|
||||||
run with `--stop`
|
run with `--stop`.
|
||||||
|
|
||||||
* `assistant`
|
* `assistant`
|
||||||
|
|
||||||
|
@ -293,7 +293,7 @@ subdirectories).
|
||||||
Typically started at boot, or when you log in.
|
Typically started at boot, or when you log in.
|
||||||
|
|
||||||
With the `--autostart` option, the assistant is started in any repositories
|
With the `--autostart` option, the assistant is started in any repositories
|
||||||
it has created. These are listed in `~/.config/git-annex/autostart`
|
it has created. These are listed in `~/.config/git-annex/autostart`.
|
||||||
|
|
||||||
* `webapp`
|
* `webapp`
|
||||||
|
|
||||||
|
@ -319,7 +319,7 @@ subdirectories).
|
||||||
|
|
||||||
It's useful, but not mandatory, to initialize each new clone
|
It's useful, but not mandatory, to initialize each new clone
|
||||||
of a repository with its own description. If you don't provide one,
|
of a repository with its own description. If you don't provide one,
|
||||||
one will be generated.
|
one will be generated using the username, hostname and the path.
|
||||||
|
|
||||||
* `describe repository description`
|
* `describe repository description`
|
||||||
|
|
||||||
|
@ -340,7 +340,7 @@ subdirectories).
|
||||||
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
|
||||||
|
@ -381,7 +381,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 with 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
|
||||||
|
@ -417,7 +417,7 @@ subdirectories).
|
||||||
|
|
||||||
* `dead [repository ...]`
|
* `dead [repository ...]`
|
||||||
|
|
||||||
Indicates that the repository has been irretrevably lost.
|
Indicates that the repository has been irretrievably lost.
|
||||||
(To undo, use semitrust.)
|
(To undo, use semitrust.)
|
||||||
|
|
||||||
* `group repository groupname`
|
* `group repository groupname`
|
||||||
|
@ -632,7 +632,7 @@ subdirectories).
|
||||||
`--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"`
|
||||||
|
|
||||||
To generate output suitable for the gource visualisation program,
|
To generate output suitable for the gource visualization program,
|
||||||
specify `--gource`.
|
specify `--gource`.
|
||||||
|
|
||||||
* `info [directory ...]`
|
* `info [directory ...]`
|
||||||
|
@ -652,6 +652,7 @@ subdirectories).
|
||||||
Then run:
|
Then run:
|
||||||
|
|
||||||
git annex info --fast . --not --in here
|
git annex info --fast . --not --in here
|
||||||
|
|
||||||
* `version`
|
* `version`
|
||||||
|
|
||||||
Shows the version of git-annex, as well as repository version information.
|
Shows the version of git-annex, as well as repository version information.
|
||||||
|
@ -817,12 +818,12 @@ subdirectories).
|
||||||
|
|
||||||
* `--fast`
|
* `--fast`
|
||||||
|
|
||||||
Enables less expensive, but also less thorough versions of some commands.
|
Enable less expensive, but also less thorough versions of some commands.
|
||||||
What is avoided depends on the command.
|
What is avoided depends on the command.
|
||||||
|
|
||||||
* `--auto`
|
* `--auto`
|
||||||
|
|
||||||
Enables automatic mode. Commands that get, drop, or move file contents
|
Enable automatic mode. Commands that get, drop, or move file contents
|
||||||
will only do so when needed to help satisfy the setting of annex.numcopies,
|
will only do so when needed to help satisfy the setting of annex.numcopies,
|
||||||
and preferred content configuration.
|
and preferred content configuration.
|
||||||
|
|
||||||
|
@ -852,8 +853,8 @@ subdirectories).
|
||||||
|
|
||||||
Rather than the normal output, generate JSON. This is intended to be
|
Rather than the normal output, generate JSON. This is intended to be
|
||||||
parsed by programs that use git-annex. Each line of output is a JSON
|
parsed by programs that use git-annex. Each line of output is a JSON
|
||||||
object. Note that json output is only usable with some git-annex commands,
|
object. Note that JSON output is only usable with some git-annex commands,
|
||||||
like info and find.
|
like info, find, and whereis.
|
||||||
|
|
||||||
* `--debug`
|
* `--debug`
|
||||||
|
|
||||||
|
@ -937,7 +938,7 @@ subdirectories).
|
||||||
|
|
||||||
* `-c name=value`
|
* `-c name=value`
|
||||||
|
|
||||||
Used to override git configuration settings. May be specified multiple times.
|
Overrides git configuration settings. May be specified multiple times.
|
||||||
|
|
||||||
# FILE MATCHING OPTIONS
|
# FILE MATCHING OPTIONS
|
||||||
|
|
||||||
|
@ -1020,13 +1021,13 @@ file contents are present at either of two repositories.
|
||||||
|
|
||||||
Matches files that the preferred content settings for the repository
|
Matches files that the preferred content settings for the repository
|
||||||
make it want to get. Note that this will match even files that are
|
make it want to get. Note that this will match even files that are
|
||||||
already present, unless limited with eg, `--not --in .`
|
already present, unless limited with e.g., `--not --in .`
|
||||||
|
|
||||||
* `--want-drop`
|
* `--want-drop`
|
||||||
|
|
||||||
Matches files that the preferred content settings for the repository
|
Matches files that the preferred content settings for the repository
|
||||||
make it want to drop. Note that this will match even files that have
|
make it want to drop. Note that this will match even files that have
|
||||||
already been dropped, unless limited with eg, `--in .`
|
already been dropped, unless limited with e.g., `--in .`
|
||||||
|
|
||||||
* `--not`
|
* `--not`
|
||||||
|
|
||||||
|
@ -1076,7 +1077,7 @@ built-in preferred content expression developed for that group.
|
||||||
The git-annex assistant daemon can be configured to run scheduled jobs.
|
The git-annex assistant daemon can be configured to run scheduled jobs.
|
||||||
This is similar to cron and anacron (and you can use them if you prefer),
|
This is similar to cron and anacron (and you can use them if you prefer),
|
||||||
but has the advantage of being integrated into git-annex, and so being able
|
but has the advantage of being integrated into git-annex, and so being able
|
||||||
to eg, fsck a repository on a removable drive when the drive gets
|
to e.g., fsck a repository on a removable drive when the drive gets
|
||||||
connected.
|
connected.
|
||||||
|
|
||||||
The scheduled jobs can be configured using `git annex vicfg` or
|
The scheduled jobs can be configured using `git annex vicfg` or
|
||||||
|
@ -1238,7 +1239,7 @@ Here are all the supported configuration settings.
|
||||||
* `remote.<name>.annex-cost-command`
|
* `remote.<name>.annex-cost-command`
|
||||||
|
|
||||||
If set, the command is run, and the number it outputs is used as the cost.
|
If set, the command is run, and the number it outputs is used as the cost.
|
||||||
This allows varying the cost based on eg, the current network. The
|
This allows varying the cost based on e.g., the current network. The
|
||||||
cost-command can be any shell command line.
|
cost-command can be any shell command line.
|
||||||
|
|
||||||
* `remote.<name>.annex-start-command`
|
* `remote.<name>.annex-start-command`
|
||||||
|
@ -1423,7 +1424,7 @@ Here are all the supported configuration settings.
|
||||||
|
|
||||||
It is set to "true" if this is a gcrypt remote.
|
It is set to "true" if this is a gcrypt remote.
|
||||||
If the gcrypt remote is accessible over ssh and has git-annex-shell
|
If the gcrypt remote is accessible over ssh and has git-annex-shell
|
||||||
available to manage it, it's set to "shell"
|
available to manage it, it's set to "shell".
|
||||||
|
|
||||||
* `remote.<name>.hooktype`, `remote.<name>.externaltype`
|
* `remote.<name>.hooktype`, `remote.<name>.externaltype`
|
||||||
|
|
||||||
|
@ -1470,7 +1471,7 @@ Most of git-annex's documentation is available on its web site,
|
||||||
<http://git-annex.branchable.com/>
|
<http://git-annex.branchable.com/>
|
||||||
|
|
||||||
If git-annex is installed from a package, a copy of its documentation
|
If git-annex is installed from a package, a copy of its documentation
|
||||||
should be included, in, for example, `/usr/share/doc/git-annex/`
|
should be included, in, for example, `/usr/share/doc/git-annex/`.
|
||||||
|
|
||||||
# AUTHOR
|
# AUTHOR
|
||||||
|
|
||||||
|
@ -1478,4 +1479,4 @@ Joey Hess <joey@kitenet.net>
|
||||||
|
|
||||||
<http://git-annex.branchable.com/>
|
<http://git-annex.branchable.com/>
|
||||||
|
|
||||||
Warning: Automatically converted into a man page by mdwn2man. Edit with care
|
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
|
||||||
|
|
Loading…
Reference in a new issue