Add a manpage - sent - simple plaintext presentation tool | |
git clone git://git.suckless.org/sent | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit b737e3e6af9e6999baace5d453e405f32c60b2d2 | |
parent c3a0671f68f894c5d7a54d934170cfd1560416c4 | |
Author: FRIGN <[email protected]> | |
Date: Fri, 12 Aug 2016 11:36:15 +0200 | |
Add a manpage | |
Diffstat: | |
M Makefile | 4 ++++ | |
A sent.1 | 66 +++++++++++++++++++++++++++++… | |
2 files changed, 70 insertions(+), 0 deletions(-) | |
--- | |
diff --git a/Makefile b/Makefile | |
@@ -48,6 +48,10 @@ install: all | |
@mkdir -p ${DESTDIR}${PREFIX}/bin | |
@cp -f sent ${DESTDIR}${PREFIX}/bin | |
@chmod 755 ${DESTDIR}${PREFIX}/bin/sent | |
+ @echo installing manual page to ${DESTDIR}${MANPREFIX}/man1 | |
+ @mkdir -p ${DESTDIR}${MANPREFIX}/man1 | |
+ @cp sent.1 ${DESTDIR}${MANPREFIX}/man1/sent.1 | |
+ @chmod 644 ${DESTDIR}${MANPREFIX}/man1/sent.1 | |
uninstall: | |
@echo removing executable file from ${DESTDIR}${PREFIX}/bin | |
diff --git a/sent.1 b/sent.1 | |
@@ -0,0 +1,66 @@ | |
+.Dd 2016-08-12 | |
+.Dt SENT 1 | |
+.Sh NAME | |
+.Nm sent | |
+.Nd simple plaintext presentation tool | |
+.Sh SYNOPSIS | |
+.Nm | |
+.Op Fl v | |
+.Op Ar file | |
+.Sh DESCRIPTION | |
+.Nm | |
+is a simple plaintext presentation tool for X. It does not need LaTeX, | |
+LibreOffice or any other fancy file format. Instead, it uses plaintext | |
+files to describe the slides, including support for images. | |
+.Pp | |
+Every paragraph represents a slide in the presentation. Especially for | |
+presentations using the Takahashi method this is very nice and allows | |
+you to write down the presentation for a quick lightning talk within a | |
+few minutes. | |
+.Sh OPTIONS | |
+.Bl -tag -width Ds | |
+.It Fl v | |
+Print version information to stdout and exit. | |
+.El | |
+.Sh USAGE | |
+.Bl -tag -width Ds | |
+.It Em Mouse commands | |
+.Bl -tag -width Ds | |
+.It Sy Button1 | Button5 | |
+Go to next slide, if existant. | |
+.It Sy Button3 | Button4 | |
+Go to previous slide, if existant. | |
+.El | |
+.It Em Keyboard commands | |
+.Bl -tag -width Ds | |
+.It Sy Escape | q | |
+Quit. | |
+.It Sy Right | Return | Space | l | j | Down | Next | n | |
+Go to next slide, if existant. | |
+.It Sy Left | Backspace | h | k | Up | Prior | p | |
+Go to previous slide, if existant. | |
+.El | |
+.El | |
+.Sh FORMAT | |
+The presentation file is made up of at least one paragraph, with an | |
+empty line separating two slides. | |
+Each input line is interpreted literally, except from control characters | |
+at the beginning of lines described as follows: | |
+.Bl -tag -width Ds | |
+.It Sy @ | |
+Create individual slide containing the image pointed to by the filename | |
+following the | |
+.Sy @ . | |
+.It Sy # | |
+Ignore this input line. | |
+.It Sy \e | |
+Create input line using the characters following the | |
+.Sy \e | |
+without interpreting them. | |
+.El | |
+.Sh CUSTOMIZATION | |
+.Nm | |
+can be customized by creating a custom config.h and (re)compiling the | |
+source code. This keeps it fast, secure and simple. | |
+.Sh SEE ALSO | |
+.Xr 2ff 1 |