git-annex/doc/git-annex-unannex.mdwn
Joey Hess b184fc490a
split out common options to its own page and mention it on each subcommand page
Sometimes users would get confused because an option they were looking
for was not mentioned on a subcommand's man page, and they had not
noticed that the main git-annex man page had a list of common options.
This change lets each subcommand mention the common options, similarly
to how the matching options are handled.

This commit was sponsored by Svenne Krap on Patreon.
2021-05-10 15:00:13 -04:00

46 lines
1.1 KiB
Markdown

# NAME
git-annex unannex - undo accidental add command
# SYNOPSIS
git annex unannex `[path ...]`
# DESCRIPTION
Use this to undo an accidental `git annex add` command. It puts the
file back how it was before the add.
Note that for safety, the content of the file remains in the annex,
until you use `git annex unused` and `git annex dropunused`.
This is not the command you should use if you intentionally added a
file some time ago, and don't want its contents any more. In that
case you should use `git annex drop` instead, and you can also
`git rm` the file.
# OPTIONS
* `--fast`
Normally this does a slow copy of the file. In `--fast` mode, it
instead makes a hard link from the file to the content in the annex.
But use --fast mode with caution, because editing the file will
change the content in the annex.
* file matching options
The [[git-annex-matching-options]](1)
can be used to specify files to unannex.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.