2 files changed, 54 insertions(+), 1 deletions(-)

M Makefile
A man/note.1

@@ 2,6 2,7 @@ PREFIX ?= /usr
 DESTDIR ?= 
 BINDIR ?= $(PREFIX)/bin
 BASHCOMPDIR ?= $(PREFIX)/share/bash-completion/completions
+MANDIR ?= $(PREFIX)/share/man
 
 all:
 	@echo "Note is a shell script, so there is nothing to do. Try \"make install\" instead."


@@ 9,10 10,12 @@ all:
 install:
 	@install -v -d "$(DESTDIR)$(BINDIR)/" && install -m 0755 -v src/note "$(DESTDIR)$(BINDIR)/note"
 	@install -v -d "$(DESTDIR)$(BASHCOMPDIR)" && install -m 0644 -v src/note.bash-completion "$(DESTDIR)$(BASHCOMPDIR)/note"
+	@install -v -d "$(DESTDIR)$(MANDIR)" && install -m 0644 -v man/note.1 "$(DESTDIR)$(MANDIR)/man1/note.1"
 
 uninstall:
 	@rm -vrf \
 		"$(DESTDIR)$(BINDIR)/note" \
-		"$(DESTDIR)$(BASHCOMPDIR)/note"
+		"$(DESTDIR)$(BASHCOMPDIR)/note" \
+		"$(DESTDIR)$(MANDIR)/man1/note.1"
 
 .PHONY: install uninstall 

@@ 0,0 1,50 @@
+.TH NOTE 1 "2019 September 13" "Note"
+
+.SH NAME
+note - stores, manages and synchronizes notes.
+
+.SH SYNOPSIS
+.B note
+[
+.I COMMAND
+] [
+.I ARGS
+] ...
+
+.SH DESCRIPTION
+.B pass
+is a very simple command line utility that keeps notes inside a simple directory
+residing at
+.IR ~/.local/share/notes/ .
+The
+.B note
+utility provides a series of commands for manipulating the notes directory
+allowing the user to open, remove, move and synchronize notes.
+
+If no COMMAND is specified, COMMAND defaults to
+.B help.
+
+Otherwise COMMAND must be one of the valid commands listed below.
+
+Several of the commands below rely on or provide additional functionality if the
+notes directory is also a git repository. If the notes directory is a git
+repository, all note modification commands will cause a corresponding git
+commit.
+
+.SH COMMANDS
+
+.B init
+
+.B ls
+
+.B open
+
+.B rm
+
+.B mv
+
+.B cat
+
+.B git
+
+.B help