From 710b00da87155c5c3446f664970a8700fbfcaa96 Mon Sep 17 00:00:00 2001
From: EuAndreh <eu@euandre.org>
Date: Wed, 17 Feb 2021 21:52:54 -0300
Subject: Move manpages to doc/

---
 doc/remembering.1 | 97 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 97 insertions(+)
 create mode 100644 doc/remembering.1

(limited to 'doc/remembering.1')

diff --git a/doc/remembering.1 b/doc/remembering.1
new file mode 100644
index 0000000..d37b4ae
--- /dev/null
+++ b/doc/remembering.1
@@ -0,0 +1,97 @@
+.TH REMEMBERING 1 @DATE@ "remembering @VERSION@"
+.
+.
+.SH NAME
+remembering - sort list using previous choices as weight
+.
+.
+.SH SYNOPSYS
+.B remembering
+.RB -p
+.IR profile
+.RB -c
+.IR command
+.
+.
+.SH DESCRIPTION
+.B remembering
+takes a command that chooses an option as its behaviour, such as
+.B fzf
+or
+.B dmenu
+and
+.IR remembers
+what option is chosen, and as it is used, will put the most used choices at the beginning of the list.
+.
+.
+.SH OPTIONS
+.
+.TP
+.B -c
+The
+.IR command
+to be executed, reading from standard input (STDIN).
+.
+.TP
+.B -p
+The name of the
+.IR profile
+where to look up and store raking data.
+.
+.TP
+.B -h
+Show short help text.
+.
+.TP
+.B -V
+Show version number.
+.
+.
+.SH EXAMPLES
+.P
+List current directory and feed it to
+.IR fzf
+via
+.B remembering:
+.RS
+.EX
+
+$ ls | remembering -p fzf-ls -c fzf
+.EE
+.RE
+.
+.P 
+Lists all executables available in
+.B $PATH,
+and feed those to 
+.IR dmenu
+via
+.B remembering, 
+and execute with
+.B sh
+the choice picked:
+.RS
+.EX
+
+$ dmenu_path | remembering -p dmenu-exe -c 'dmenu' | sh
+.EE
+.RE
+.
+.P
+Successive invocations will put the frequent choices at the beginning.
+.
+.
+.SH SEE ALSO
+.IR remembering (5)
+.
+.
+.SH AUTHORS
+EuAndreh <eu@euandre.org>
+.
+.
+.SH BUGS
+Report bugs and send patches to: ~euandreh/public-inbox@lists.sr.ht
+.br
+Home page: https://remembering.euandreh.xyz
+.br
+Source code: https://git.euandreh.xyz/remembering
-- 
cgit v1.2.3