Skip to content

Commit

Permalink
Install manpage in DEB and RPM.
Browse files Browse the repository at this point in the history
Add note to README about executable name change.

Update version number.
  • Loading branch information
LebJe committed Mar 10, 2021
1 parent c9d1703 commit c4e70fa
Show file tree
Hide file tree
Showing 7 changed files with 111 additions and 14 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@ Brewfile.lock.json
xcuserdata/
Package.resolved
/.swiftpm
LFSPointers.1
2 changes: 1 addition & 1 deletion LFSPointers.1.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
% LFSPOINTERS(1) Version 4.0.0 | LFSPointers Documentation
% LFSPOINTERS(1) Version 4.0.1 | LFSPointers Documentation

NAME
====
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
[![Build and Test](https://github.com/LebJe/LFSPointers/workflows/Build%20and%20Test/badge.svg)](https://github.com/LebJe/LFSPointers/actions?query=workflow%3A%22Build+and+Test%22)
[![Build Container](https://github.com/LebJe/LFSPointers/workflows/Build%20Container/badge.svg)](https://github.com/LebJe/LFSPointers/actions?query=workflow%3A%22Build+Container%22)

**4.0.1 is the last release in which the executable is named `LFSPointers`. All future releases will name it `lfs-pointers`.**

Table of Contents
=================

Expand Down
10 changes: 5 additions & 5 deletions ReleaseProcess.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

1. Update version number in `README.md`, line 202.
2. Update version number in `Sources/LFSPointersExecutable/main.swift`, line 42.
3. Create GitHub release, and wait for builds to finish.
3. Update version number in `Scripts/installDeb.sh`.
4. Update version number in [lfs-pointers.rb](https://github.com/LebJe/homebrew-formulae/blob/master/lfs-pointers.rb).
5. Update version number in `LFSPointers.1.md`.
6. Build Homebrew bottle.
3. Update version number in `LFSPointers.1.md`.
4. Create GitHub release, and wait for builds to finish.
5. Update version number in `Scripts/installDeb.sh`.
6. Update version number in [lfs-pointers.rb](https://github.com/LebJe/homebrew-formulae/blob/master/lfs-pointers.rb).
7. Build Homebrew bottle.
2 changes: 1 addition & 1 deletion Sources/LFSPointersExecutable/main.swift
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ struct LFSPointersCommand: ParsableCommand {
commandName: "LFSPointers",
abstract: "Replaces large files in a Git repository with Git LFS pointers.",
discussion: "JSON STRUCTURE:\n\(jsonStructure)",
version: "4.0.0"
version: "4.0.1"
)

@Flag(name: .shortAndLong, help: "Whether to display verbose output.")
Expand Down
94 changes: 94 additions & 0 deletions lfs-pointers.1
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]>
14 changes: 8 additions & 6 deletions package.yaml
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"

0 comments on commit c4e70fa

Please sign in to comment.