photo-stats

commit 18bfb377715999e7257b3753e9d3eab57cdd4c9e
parent c68ea0d80c3ed868312948783dc5012869d079cf
Author: René Wagner <rwa@clttr.info>
Date:   Tue,  4 Apr 2023 17:33:30 +0200

improve 5 & 7 manpages

Diffstat:
M
Makefile
 | 
11
++++++++---
M
phosta-alias.5.scd
 | 
6
+++---
M
phosta-examples.7.scd
 | 
7
++++---
A
phosta-faq.7.scd
 | 
23
+++++++++++++++++++++++

4 files changed, 38 insertions(+), 9 deletions(-)
diff --git a/Makefile b/Makefile
@@ -16,10 +16,13 @@ phosta-alias.5: phosta-alias.5.scd
 phosta-examples.7: phosta-examples.7.scd
 	scdoc < $< > $@
 
-all: phosta phosta.1 phosta-alias.5 phosta-examples.7
+phosta-faq.7: phosta-faq.7.scd
+	scdoc < $< > $@
+
+all: phosta phosta.1 phosta-alias.5 phosta-examples.7 phosta-faq.7
 
 clean:
-	rm -rf phosta.1 phosta-alias.5 phosta-examples.7
+	rm -rf phosta.1 phosta-alias.5 phosta-examples.7 phosta-faq.7
 
 install: all
 	mkdir -p $(DESTDIR)/$(BINDIR) $(DESTDIR)/$(MANDIR)/man1 $(DESTDIR)/$(MANDIR)/man5 $(DESTDIR)/$(MANDIR)/man7 $(DESTDIR)/$(DOCDIR)/phosta/
@@ -27,6 +30,7 @@ install: all
 	install -m644 phosta.1 $(DESTDIR)/$(MANDIR)/man1/phosta.1
 	install -m644 phosta-alias.5 $(DESTDIR)/$(MANDIR)/man5/phosta-alias.5
 	install -m644 phosta-examples.7 $(DESTDIR)/$(MANDIR)/man7/phosta-examples.7
+	install -m644 phosta-faq.7 $(DESTDIR)/$(MANDIR)/man7/phosta-faq.7
 	install -m644 LICENSE $(DESTDIR)/$(DOCDIR)/phosta/LICENSE
 
 uninstall:
@@ -34,6 +38,7 @@ uninstall:
 	rm -f $(DESTDIR)/$(MANDIR)/man1/phosta.1
 	rm -f $(DESTDIR)/$(MANDIR)/man5/phosta-alias.5
 	rm -f $(DESTDIR)/$(MANDIR)/man7/phosta-examples.7
+	rm -f $(DESTDIR)/$(MANDIR)/man7/phosta-faq.7
 
-check: phosta phosta.1 phosta-alias.5 phosta-examples.7
+check: phosta phosta.1 phosta-alias.5 phosta-examples.7 phosta-faq.7
 	@find test -perm -111 -exec '{}' \;
diff --git a/phosta-alias.5.scd b/phosta-alias.5.scd
@@ -1,7 +1,7 @@
-PHOSTA-ALIAS(5)
+phosta-alias(5) "phosta" "Alias File Format Definition"
 
 # NAME
-.phosta.alias - configuration of word replacement for *phosta*(1)
+phosta-alias - configuration of word replacement for *phosta*(1)
 
 # SYNOPSIS
 *phosta* allows to configure automatic word replacement during the import of data.
@@ -22,7 +22,7 @@ lensname        real lensname
 
 # SEE ALSO
 
-*phosta*(1), *phosta-examples*(7)
+*phosta*(1), *phosta-examples*(7), *phosta-faq*(7)
 
 # AUTHORS
 
diff --git a/phosta-examples.7.scd b/phosta-examples.7.scd
@@ -1,4 +1,4 @@
-PHOSTA-EXAMPLES(7)
+phosta-examples(7) "phosta" "phosta Examples"
 
 # NAME
 phosta-examples - collection of example calls with params for  *phosta*(1)
@@ -8,7 +8,8 @@ phosta-examples - collection of example calls with params for  *phosta*(1)
 This allows to sanitize and unify ambigous naming used by different image processing tools.
 
 # EXAMPLES
-- load EXIF data of files with the extensions jpg, jpeg and tiff in folder _~/Pictures_ to the database located in _~/Documents/stats.db_
+## GATHER DATA
+- load data of files with the extensions jpg, jpeg and tiff in folder _~/Pictures_ to the database located in _~/Documents/stats.db_
 ```
 phosta -E jpg,jpeg,tiff -D ~/Documents/stats.db -p ~/Pictures
 ```
@@ -31,7 +32,7 @@ phosta -s model -f maker!=ricoh
 
 # SEE ALSO
 
-*phosta*(1), *phosta-alias*(5)
+*phosta*(1), *phosta-alias*(5), *phosta-faq*(7)
 
 # AUTHORS
 
diff --git a/phosta-faq.7.scd b/phosta-faq.7.scd
@@ -0,0 +1,23 @@
+phosta-faq(7) "phosta" "Frequently Asked Questions"
+
+# NAME
+phosta-faq - frequently asked questions about the usage of *phosta*(1)
+
+# FAQ
+*I want to use a filter with whitespaces, how can i do that?*
+	You need to surround the parameter value with quotation marks, e.g. phosta -f "maker=best company".
+
+*I have my images on a network share, how can i include them into the stats?*
+	You should mount the share and use is like a local directory.
+
+*Can i add different folders to the statistics?*
+	Omit the -c param when populating the database to avoid cleaning up old values. The tool will take care that no duplicates are added. The duplicate detection is based on file path and name.
+
+# SEE ALSO
+
+*phosta*(1), *phosta-alias*(5), *phosta-examples*(7)
+
+# AUTHORS
+
+Maintained by René Wagner <rwa@clttr.info>.
+Project repo can be found at https://git.sr.ht/~rwa/photo-stats