Update documentation files

3 files changed, 57 insertions, 4 deletions

diff --git a/scripts/Makefile b/scripts/Makefile
index bf51ce7..e31a6fd 100644
--- a/scripts/Makefile
+++ b/scripts/Makefile
@@ -1,9 +1,18 @@
+PREFIX ?= ..
+
 all: synthesis
 
-synthesis: synthesis-results.scm
+%: %.scm
 	chicken-csc -static -o $@ $<
 
-install: synthesis
-	install -s $< ~/.local/bin
+%.1: %.org
+	emacs --batch --file $< --load ../docs/res/publish.el --funcall org-man-export-to-man
+	cp $(<:.org=.man) $@
+
+install: synthesis-results synthesis-results.1
+	install -d $(PREFIX)/bin
+	install -C synthesis-results $(PREFIX)/bin
+	install -d $(PREFIX)/share/man/man1
+	install -C synthesis-results.1 $(PREFIX)/share/man/man1
 
 .PHONY: all install
diff --git a/scripts/synthesis-results.org b/scripts/synthesis-results.org
new file mode 100644
index 0000000..602b2ba
--- /dev/null
+++ b/scripts/synthesis-results.org
@@ -0,0 +1,44 @@
+#+title: synthesis-results
+#+man_class_options: :section-id "1"
+#+options: toc:nil num:nil
+#+html_head_extra: <style>body{font-family:monospace;max-width:60em}h1{text-align:center}dt{font-weight:700}dd{margin-bottom:1em}</style>
+
+* NAME
+
+synthesis-results: sends a verilog file to be synthesised and returns results as a CSV file.
+
+* SYNOPSYS
+
+Usage: *synthesis-results* [options...] [files...]
+
+* DESCRIPTION
+
+- -v, --verbose[=LEVEL] :: Debug level [default: 0]
+- -k, --keys=KEY,KEY,... :: Keys to display [default: slice,ramfifo,delay]
+- -o, --output=FILE :: Output file
+- -s, --suppress=TYPE,TYPE,... :: Values to suppress from output [default: none]
+- -x, --xml :: Output raw XML from the synthesis tool
+- -c, --csv :: Output processed CSV
+- -V, --version :: Display version
+- -h, --help :: Display this text
+
+* AUTHOR
+
+Written by Yann Herklotz.
+
+* COPYRIGHT
+
+Copyright (C) 2022 Yann Herklotz <yann@yannherklotz.com>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
diff --git a/scripts/synthesis-results.scm b/scripts/synthesis-results.scm
index faf8919..3a87d58 100755
--- a/scripts/synthesis-results.scm
+++ b/scripts/synthesis-results.scm
@@ -32,7 +32,7 @@
 
 (: description string)
 (define description
-  "synthesise: sends a verilog file to be synthesised and returns results as a CSV file.")
+  "synthesis-results: sends a verilog file to be synthesised and returns results as a CSV file.")
 
 (define (usage)
 	(with-output-to-port (current-error-port)