summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWilfred Hughes <me@wilfred.me.uk>2024-04-27 16:21:03 -0700
committerWilfred Hughes <me@wilfred.me.uk>2024-04-27 16:21:17 -0700
commitcb63ca88303d3c8dffd763cf6e5772e45c045588 (patch)
treef62472a6380d501d9084124455cdddf36a484c34
parent5ade0bbe9c2e990768a71c53e1f975502fd87df1 (diff)
Write a basic man page
-rw-r--r--difft.129
-rw-r--r--difft.1.md36
-rw-r--r--justfile3
3 files changed, 68 insertions, 0 deletions
diff --git a/difft.1 b/difft.1
new file mode 100644
index 000000000..09234e736
--- /dev/null
+++ b/difft.1
@@ -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 me@wilfred.me.uk
+.ME \c
diff --git a/difft.1.md b/difft.1.md
new file mode 100644
index 000000000..0362c7eac
--- /dev/null
+++ b/difft.1.md
@@ -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 <me@wilfred.me.uk>
diff --git a/justfile b/justfile
index bd125d1dc..5a55f42e4 100644
--- a/justfile
+++ b/justfile
@@ -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