~lh2/slideshow

7325ea661fc83d8dd5d291d91fae870ecf3e1554 — Lukas Henkel 5 years ago ecaa490
Added documentation
3 files changed, 63 insertions(+), 0 deletions(-)

A .gitignore
A Makefile
A slideshow.1.scd
A .gitignore => .gitignore +3 -0
@@ 0,0 1,3 @@
slideshow
slideshow.1
test.ff

A Makefile => Makefile +22 -0
@@ 0,0 1,22 @@
PREFIX?=/usr/local
MANPREFIX=${PREFIX}/share/man

all: slideshow slideshow.1

slideshow:
	go build entf.net/slideshow

slideshow.1: slideshow.1.scd
	scdoc < $< > $@

install: all
	mkdir -p ${DESTDIR}${PREFIX}/bin
	cp -f slideshow ${DESTDIR}${PREFIX}/bin
	mkdir -p ${DESTDIR}${MANPREFIX}/man1
	cp -f slideshow.1 ${DESTDIR}${MANPREFIX}/man1

uninstall:
	-rm -f ${DESTDIR}${PREFIX}/bin/slideshow
	-rm -f ${DESTDIR}${MANPREFIX}/man1/slideshow.1

.PHONY: all slideshow install uninstall

A slideshow.1.scd => slideshow.1.scd +38 -0
@@ 0,0 1,38 @@
slideshow(1)

# NAME

slideshow - imageviewer controlled by stdin

# SYNOPSIS

*slideshow* [options...] < _filepaths_

# OPTIONS

*-bg*
	Background color as 6 digit hex value.

# DESCRIPTION

On launch, slideshow displays an empty window. Feed file paths to standard input
to load a new image. On every newline character, slideshow loads and displays
the image found at the specified filepath. Error messages will be written to
standard error, as long as the error in question is not fatal, the program will
remain running.

Image files need to be in *farbfeld*(5) format!

# EXAMPLES

```
$ find ~/my_farbfeld_images/ -type f | while read -r file; do echo "$file"; sleep 5s; done | slideshow
```

# SEE ALSO

*farbfeld*(5)

# AUTHORS

Lukas Henkel <lh@entf.net>