git-lfs/docs/man/git-lfs-smudge.1.ronn

git-lfs-smudge(1) -- Git smudge filter that converts pointer in blobs to the actual content
===========================================================================================

## SYNOPSIS

`git lfs smudge` [<path>]
`git lfs smudge` --skip [<path>]

## DESCRIPTION

Read a Git LFS pointer file from standard input and write the contents
of the corresponding large file to standard output.  If needed,
download the file's contents from the Git LFS endpoint.  The <path>
argument, if provided, is only used for a progress bar.

Smudge is typically run by Git's smudge filter, configured by the repository's
Git attributes.

## OPTIONS

Without any options, `git lfs smudge` outputs the raw Git LFS content to
standard output.

* `--skip`:
    Skip automatic downloading of objects on clone or pull.

* `GIT_LFS_SKIP_SMUDGE`:
    Disables the smudging process. For more, see: git-lfs-config(5).

## KNOWN BUGS

On Windows, Git does not handle files in the working tree larger than 4
gigabytes.

For more information, see: https://github.com/git-lfs/git-lfs/issues/2434.

## SEE ALSO

git-lfs-install(1), gitattributes(5).

Part of the git-lfs(1) suite.
Tidy up the man page summary lines * Such lines conventionally don't end with a full stop, so remove them. * Adjust the subsequent `========` lines to have the same length as the summary lines (the lengths were wrong because of an earlier renaming of the project). 2015-04-11 06:35:32 +00:00			`git-lfs-smudge(1) -- Git smudge filter that converts pointer in blobs to the actual content`
			`===========================================================================================`
add git clean/smudge man pages 2014-06-02 22:56:01 +00:00
			`## SYNOPSIS`

`git lfs smudge`: improve man page text 2015-04-13 08:21:48 +00:00			`git lfs smudge` [<path>]
update docs in man page 2015-09-23 20:22:38 +00:00			`git lfs smudge` --skip [<path>]
add git clean/smudge man pages 2014-06-02 22:56:01 +00:00
			`## DESCRIPTION`

`git lfs smudge`: improve man page text 2015-04-13 08:21:48 +00:00			`Read a Git LFS pointer file from standard input and write the contents`
			`of the corresponding large file to standard output. If needed,`
			`download the file's contents from the Git LFS endpoint. The <path>`
			`argument, if provided, is only used for a progress bar.`
add git clean/smudge man pages 2014-06-02 22:56:01 +00:00
			`Smudge is typically run by Git's smudge filter, configured by the repository's`
			`Git attributes.`

document smudge --info 2014-07-25 16:56:23 +00:00			`## OPTIONS`

Man pages: change command descriptions to the imperative voice 2015-04-11 07:02:18 +00:00			Without any options, `git lfs smudge` outputs the raw Git LFS content to
Expand "STDIN/STDOUT" to "standard input/output" This is the more conventional spelling in manpages. 2015-04-11 06:35:32 +00:00			`standard output.`
document smudge --info 2014-07-25 16:56:23 +00:00
update docs in man page 2015-09-23 20:22:38 +00:00			* `--skip`:
			`Skip automatic downloading of objects on clone or pull.`

docs/man/git-lfs-config.5.ronn: document GIT_LFS_SKIP_SMUDGE Since its inception in [1], the `GIT_LFS_SKIP_SMUDGE` environment variable has not been documented. This feature is not meant to be hidden, so let's document how it works in `git-lfs-config.5` in case users are interested in it. Let's write this in `git-lfs-config(5)` since this is where environment variables that aren't tied to a particular command go. We note its existence in the related manual pages (e.g., `git-lfs-smudge(1)` and `git-lfs-filter-process(1)`) but refer to the authoritative source in `git-lfs-config(5)`. [1]: 8cd51c00 (rename the options to SKIP_SMUDGE and --skip-smudge, 2015-09-23) 2019-02-05 02:57:42 +00:00			* `GIT_LFS_SKIP_SMUDGE`:
			`Disables the smudging process. For more, see: git-lfs-config(5).`

commands: warn on smudged files larger than 4gb on Windows 2017-07-31 16:37:44 +00:00			`## KNOWN BUGS`

			`On Windows, Git does not handle files in the working tree larger than 4`
			`gigabytes.`

			`For more information, see: https://github.com/git-lfs/git-lfs/issues/2434.`

add git clean/smudge man pages 2014-06-02 22:56:01 +00:00			`## SEE ALSO`

rename init => install 2015-11-16 20:31:26 +00:00			`git-lfs-install(1), gitattributes(5).`
add git clean/smudge man pages 2014-06-02 22:56:01 +00:00
rename hawser => git-lfs 2015-03-19 19:30:55 +00:00			`Part of the git-lfs(1) suite.`