-
Notifications
You must be signed in to change notification settings - Fork 0
/
lfs-pointers.1
94 lines (94 loc) · 2.41 KB
/
lfs-pointers.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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 <51171427+LebJe@users.noreply.github.com>