merge clean into smudge command

The git filter config can be used to map the single git-annex command to
the 2 actions, and this avoids "git annex clean" being used for this thing,
it might have a better use for that name later.

1 files changed, 18 insertions, 8 deletions

diff --git a/doc/git-annex-smudge.mdwn b/doc/git-annex-smudge.mdwn
index ae28be2c7..a4f458ee5 100644
--- a/doc/git-annex-smudge.mdwn
+++ b/doc/git-annex-smudge.mdwn
@@ -4,26 +4,36 @@ git-annex smudge - git filter driver for git-annex
 
 # SYNOPSIS
 
-git annex smudge
+git annex smudge [--clean] file
 
 # DESCRIPTION
 
-When git-annex is used as a git filter driver, this command is run
-by git commands such as `git checkout` and outputs the content of annexed
-objects that pointer files point to.
+This command lets git-annex be used as a git filter driver which lets
+annexed files in the git repository to be unlocked at all times, instead
+of being symlinks.
 
-To configure git to use git-annex as a git filter driver, place the
-following in the .gitattributes file:
+The git configuration to use this command as a filter driver is as follows,
+but this is normally set up for you by git-annex init, so you should
+not need to configure it manually:
+
+	[filter "annex"]
+	        clean = git-annex smudge --clean %f
+	        smudge = git-annex smudge %f
+
+To make git use this filter on all files except for dotfiles, put something
+like the following in the .gitattributes file:
 
 	* filter=annex
 	.* !filter
 
+When adding a file with `git add`, the annex.largefiles config is
+consulted to decide if a given file should be added to git as-is,
+or if its content are large enough to need to use git-annex.
+
 # SEE ALSO
 
 [[git-annex]](1)
 
-[[git-annex-clean]](1)
-
 # AUTHOR
 
 Joey Hess <id@joeyh.name>