man pages improvements
Added some examples. Tightened up some language and removed some unncessary duplicate documentaton.
This commit is contained in:
Joey Hess
parent
2a8fdfc7d8
commit
959ae7733a
7 changed files with 63 additions and 16 deletions
|
|
@ -29,6 +29,13 @@ supporting symlinks.)
|
|||
This command can also be used to add symbolic links, both symlinks to
|
||||
annexed content, and other symlinks.
|
||||
|
||||
# EXAMPLES
|
||||
|
||||
# git annex add foo bar
|
||||
add foo ok
|
||||
add bar ok
|
||||
# git commit -m added
|
||||
|
||||
# OPTIONS
|
||||
|
||||
* `--force`
|
||||
|
|
|
|||
|
|
@ -21,6 +21,19 @@ even if enough copies exist elsewhere. See [[git-annex-required]](1).
|
|||
With no parameters, tries to drop all annexed files in the current directory.
|
||||
Paths of files or directories to drop can be specified.
|
||||
|
||||
# EXAMPLES
|
||||
|
||||
# git annex drop *.jpeg
|
||||
drop photo1.jpg (checking origin...) ok
|
||||
drop photo2.jpg (unsafe)
|
||||
Could only verify the existence of 0 out of 1 necessary copies
|
||||
|
||||
Rather than dropping this file, try using: git annex move
|
||||
|
||||
(Use --force to override this check, or adjust numcopies.)
|
||||
failed
|
||||
drop photo3.jpg (checking origin...) ok
|
||||
|
||||
# OPTIONS
|
||||
|
||||
* `--from=remote`
|
||||
|
|
|
|||
|
|
@ -16,6 +16,16 @@ With no parameters, gets all annexed files in the current directory whose
|
|||
content was not already present. Paths of files or directories to get can
|
||||
be specified.
|
||||
|
||||
# EXAMPLES
|
||||
|
||||
# evince foo.pdf
|
||||
error: Unable to open document foo.pdf: No such file or directory
|
||||
# ls foo.pdf
|
||||
foo.pdf@
|
||||
# git annex get foo.pdf
|
||||
get foo.pdf (from origin..) ok
|
||||
# evince foo.pdf
|
||||
|
||||
# OPTIONS
|
||||
|
||||
* `--auto`
|
||||
|
|
|
|||
|
|
@ -29,6 +29,15 @@ in a repository. This is useful for repositories that have a policy
|
|||
reason not to use git-annex. The content of the file will be displayed
|
||||
to the user who tries to run git-annex init.
|
||||
|
||||
# EXAMPLES
|
||||
|
||||
# git annex add foo
|
||||
git-annex: First run: git-annex init
|
||||
# git annex init
|
||||
init ok
|
||||
# git annex add foo
|
||||
add foo ok
|
||||
|
||||
# OPTIONS
|
||||
|
||||
* `--version=N`
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# NAME
|
||||
|
||||
git-annex lock - undo unlock command
|
||||
git-annex lock - lock files to prevent modification
|
||||
|
||||
# SYNOPSIS
|
||||
|
||||
|
|
@ -8,8 +8,13 @@ git annex lock `[path ...]`
|
|||
|
||||
# DESCRIPTION
|
||||
|
||||
Use this to undo an unlock command if you don't want to modify
|
||||
the files any longer, or have made modifications you want to discard.
|
||||
Lock the specified annexed files, to prevent them from being modified.
|
||||
When no files are specified, all annexed files in the current directory are
|
||||
locked.
|
||||
|
||||
Locking a file changes how it is stored in the git repository (from a
|
||||
pointer file to a symlink), so this command will make a change that you
|
||||
can commit.
|
||||
|
||||
# OPTIONS
|
||||
|
||||
|
|
|
|||
|
|
@ -9,8 +9,8 @@ git annex unlock `[path ...]`
|
|||
# DESCRIPTION
|
||||
|
||||
Normally, the content of annexed files is protected from being changed.
|
||||
Unlocking an annexed file allows it to be modified. This replaces the
|
||||
symlink for each specified file with the file's content.
|
||||
Unlocking an annexed file allows it to be modified. When no files are
|
||||
specified, all annexed files in the current directory are unlocked.
|
||||
|
||||
Unlocking a file changes how it is stored in the git repository (from a
|
||||
symlink to a pointer file), so this command will make a change that you
|
||||
|
|
@ -32,6 +32,16 @@ system.) While this can save considerable disk space, any modification made
|
|||
to a file will cause the old version of the file to be lost from the local
|
||||
repository. So, enable annex.thin with care.
|
||||
|
||||
# EXAMPLES
|
||||
|
||||
# git annex unlock disk-image
|
||||
# git commit -m "unlocked to allow VM to make changes as it runs"
|
||||
|
||||
# git annex unlock photo.jpg
|
||||
# gimp photo.jpg
|
||||
# git annex lock photo.jpg
|
||||
# git commit -m "redeye removal"
|
||||
|
||||
# OPTIONS
|
||||
|
||||
* file matching options
|
||||
|
|
|
|||
|
|
@ -54,12 +54,6 @@ content from the key-value store.
|
|||
|
||||
# COMMONLY USED COMMANDS
|
||||
|
||||
Like many git commands, git-annex can be passed a path that
|
||||
is either a file or a directory. In the latter case it acts on all relevant
|
||||
files in the directory. When no path is specified, most git-annex commands
|
||||
default to acting on all relevant files in the current directory (and
|
||||
subdirectories).
|
||||
|
||||
* `help`
|
||||
|
||||
Display built-in help.
|
||||
|
|
@ -68,8 +62,7 @@ subdirectories).
|
|||
|
||||
* `add [path ...]`
|
||||
|
||||
Adds files in the path to the annex. If no path is specified, adds
|
||||
files from the current directory and below.
|
||||
Adds files to the annex.
|
||||
|
||||
See [[git-annex-add]](1) for details.
|
||||
|
||||
|
|
@ -1821,9 +1814,9 @@ These environment variables are used by git-annex when set:
|
|||
variable can confuse git-annex's book-keeping, sometimes in ways that
|
||||
`git annex fsck` is unable to repair.
|
||||
|
||||
Some special remotes use additional environment variables
|
||||
for authentication etc. For example, `AWS_ACCESS_KEY_ID`
|
||||
and `GIT_ANNEX_P2P_AUTHTOKEN`. See special remote documentation.
|
||||
* Some special remotes use additional environment variables
|
||||
for authentication etc. For example, `AWS_ACCESS_KEY_ID`
|
||||
and `GIT_ANNEX_P2P_AUTHTOKEN`. See special remote documentation.
|
||||
|
||||
# FILES
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue