-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add note to README about executable name change. Update version number.
- Loading branch information
Showing
7 changed files
with
111 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,4 +6,3 @@ Brewfile.lock.json | |
xcuserdata/ | ||
Package.resolved | ||
/.swiftpm | ||
LFSPointers.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
.\" Automatically generated by Pandoc 2.12 | ||
.\" | ||
.TH "LFSPOINTERS" "1" "" "Version 4.0.1" "LFSPointers Documentation" | ||
.hy | ||
.SH NAME | ||
.PP | ||
\f[B]LFSPointers\f[R] \[em] Replaces large files in a Git repository | ||
directory with Git LFS pointers. | ||
.SH SYNOPSIS | ||
.PP | ||
\ \f[B]LFSPointers\f[R] [--verbose] [--silent] [--recursive] [--all] | ||
[--json] [--enable-color] [--disable-color] [--json-format ] | ||
[--backup-directory ] <directory> [<files> \&...] | ||
.SH DESCRIPTION | ||
.PP | ||
Let\[cq]s imagine you have a directory of large \f[C]png\f[R] and | ||
\f[C]jpg\f[R] files called \f[C]Project Logos\f[R]. | ||
If you wanted to convert the files with the extension \f[C]png\f[R] to | ||
LFS pointers, you could run: | ||
.IP | ||
.nf | ||
\f[C] | ||
$ LFSPointers path/to/Project\[rs] Logos path/to/Project\[rs] Logos/*.png | ||
\f[R] | ||
.fi | ||
.PP | ||
The first argument is the path to the directory, and the second argument | ||
is a regular expression used to search for \f[C]png\f[R] files that your | ||
shell will convert to a list of filenames. | ||
.PD 0 | ||
.P | ||
.PD | ||
But wait! It\[cq]s not safe to run random programs on your computer! To | ||
backup your files just in case something goes wrong, add | ||
\f[C]-b path/to/backup-directory\f[R] to the previous command, like | ||
this: | ||
.IP | ||
.nf | ||
\f[C] | ||
$ LFSPointers -b path/to/backup-directory path/to/Project\[rs] Logos path/to/Project\[rs] Logos/*.png | ||
\f[R] | ||
.fi | ||
.PP | ||
If you want to generate JSON output instead, run: | ||
.IP | ||
.nf | ||
\f[C] | ||
$ LFSPointers --json path/to/Project\[rs] Logos path/to/Project\[rs] Logos/*.png | ||
\f[R] | ||
.fi | ||
.SS Options | ||
.TP | ||
-v, --verbose | ||
Whether to display verbose output. | ||
.TP | ||
--silent | ||
Don\[cq]t print to standard output or standard error. | ||
.TP | ||
-r, --recursive | ||
Repeat this process in all directories. | ||
.TP | ||
-a, --all | ||
Convert all files to pointers (USE WITH CAUTION!). | ||
.TP | ||
-j, --json | ||
Sends JSON to standard output. | ||
The JSON is structured as shown above. | ||
This will automatically enable --silent. | ||
.TP | ||
--enable-color/--disable-color | ||
Whether to send colorized output to the terminal or not. | ||
(default: true) | ||
.TP | ||
--json-format, -jf | ||
The format in which JSON is printed. | ||
You can choose either \[lq]compact\[rq] or \[lq]formatted\[rq]. | ||
(default: compact) | ||
.TP | ||
-b, --backup-directory | ||
The directory files will be copied to before being processed. | ||
If no directory is specified, no files will be copied. | ||
(default: nil) | ||
.TP | ||
--version | ||
Show the version. | ||
.TP | ||
-h, --help | ||
Show help information. | ||
.SH BUGS | ||
.PP | ||
See GitHub Issues: <https://github.com/LebJe/LFSPointers/issues> | ||
.SH AUTHOR | ||
.PP | ||
LebJe <[email protected]> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,14 @@ | ||
meta: | ||
description: A Swift library and CLI that allows you to convert a Git repository of large files to Git LFS pointers. | ||
vendor: LebJe | ||
maintainer: LebJe | ||
description: "A Swift library and CLI that allows you to convert a Git repository of large files to Git LFS pointers." | ||
vendor: "LebJe" | ||
maintainer: "LebJe" | ||
files: | ||
"/usr/bin/LFSPointers": | ||
file: LFSPointers | ||
file: "LFSPointers" | ||
mode: "0755" | ||
"/etc/bash_completion.d/LFSPointers.bash": | ||
file: LFSPointers.bash | ||
file: "LFSPointers.bash" | ||
"/usr/share/zsh/site-functions/_LFSPointers": | ||
file: _LFSPointers | ||
file: "_LFSPointers" | ||
"/usr/share/man/man1/lfs-pointers.1": | ||
file: "lfs-pointers.1" |