Skip to content

Commit

Permalink
Write a basic man page
Browse files Browse the repository at this point in the history
  • Loading branch information
Wilfred committed Apr 27, 2024
1 parent 5ade0bb commit cb63ca8
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 0 deletions.
29 changes: 29 additions & 0 deletions difft.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
.\" Automatically generated by Pandoc 3.1.13
.\"
.TH "DIFFT" "1" "" "" ""
.SH NAME
\f[B]difft\f[R] \- a structural diff tool that understands syntax
.SH SYNOPSIS
\f[B]difft\f[R] [\f[I]OPTIONS\f[R]] \f[I]OLD\-PATH\f[R]
\f[I]NEW\-PATH\f[R]
.PP
\f[B]difft\f[R] [\f[I]OPTIONS\f[R]] \f[I]DIRECTORY\-ONE\f[R]
\f[I]DIRECTORY\-TWO\f[R]
.PP
\f[B]difft\f[R] [\f[I]OPTIONS\f[R]] \f[I]FILE\-WITH\-CONFLICTS\f[R]
.PP
\f[B]difft\f[R] \f[B]\-\-list\-languages\f[R]
.PP
\f[B]difft\f[R] \f[B]\-\-help\f[R]
.SH DESCRIPTION
difftastic (difft) is a CLI diff tool that compares files based on their
syntax, not line\-by\-line.
Difftastic produces accurate diffs that are easier for humans to read.
.SH BUGS
See GitHub Issues: \c
.UR https://github.com/Wilfred/difftastic/issues
.UE \c
.SH AUTHOR
Wilfred Hughes \c
.MT [email protected]
.ME \c
36 changes: 36 additions & 0 deletions difft.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
% DIFFT(1)

NAME
====

**difft** - a structural diff tool that understands syntax

SYNOPSIS
========

**difft** \[_OPTIONS_] _OLD-PATH_ _NEW-PATH_

**difft** \[_OPTIONS_] _DIRECTORY-ONE_ _DIRECTORY-TWO_

**difft** \[_OPTIONS_] _FILE-WITH-CONFLICTS_

**difft** **\-\-list-languages**

**difft** **\-\-help**

DESCRIPTION
===========

difftastic (difft) is a CLI diff tool that compares files based on
their syntax, not line-by-line. Difftastic produces accurate diffs
that are easier for humans to read.

BUGS
====

See GitHub Issues: <https://github.com/Wilfred/difftastic/issues>

AUTHOR
======

Wilfred Hughes <[email protected]>
3 changes: 3 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@ rel_notes:
echo -e "Difftastic is a structural diff tool that understands syntax. See [the manual](https://difftastic.wilfred.me.uk/) to get started, and [the changelog](https://github.com/Wilfred/difftastic/blob/master/CHANGELOG.md) for historical changes.\n"

rg --max-count 1 -B 9999 "released " CHANGELOG.md | tail -n +3 | head -n -2

man:
pandoc --standalone --to man difft.1.md -o difft.1

0 comments on commit cb63ca8

Please sign in to comment.