sent/README.md
Markus Teich b954ed4b9f Fix cmdline argument check
There was a segfault when sent was called without arguments. Now we use stdin
when there's no argument or - is used. Thanks to izabera for the report.
2016-03-06 20:49:18 +01:00

58 lines
1.3 KiB
Markdown

sent is a simple plaintext presentation tool.
sent does not need latex, libreoffice or any other fancy file format, it uses
plaintext files to describe the slides and can include images via farbfeld.
Every paragraph represents a slide in the presentation.
The presentation is displayed in a simple X11 window. The content of each slide
is automatically scaled to fit the window and centered so you also don't have to
worry about alignment. Instead you can really concentrate on the content.
Dependencies
You need Xlib to build sent and the farbfeld[0] tools installed to use images in
your presentations.
Demo
To get a little demo, just type
make && ./sent example
You can navigate with the arrow keys and quit with `q`.
Usage
sent [FILE]
If FILE is omitted or equals `-`, stdin will be read. Produce image slides by
prepending a `@` in front of the filename as a single paragraph. Lines starting
with `#` will be ignored. A `\` at the beginning of the line escapes `@` and
`#`. A presentation file could look like this:
sent
@nyan.png
depends on
- Xlib
sent FILENAME
one slide per paragraph
# This is a comment and will not be part of the presentation
\# This and the next line start with backslashes
\@FILE.png
thanks / questions?
Development
sent is developed at http://tools.suckless.org/sent
0: http://tools.suckless.org/farbfeld/