nsxivd3da0eb
Added man page
+84 −3
4 files changed
| @@ -19,6 +19,9 @@ sxiv: $(OBJFILES) | |||
| 19 | 19 | ||
| 20 | 20 | install: all | |
| 21 | 21 | install -D -m 4755 -o root -g root sxiv $(PREFIX)/sbin/sxiv | |
| 22 | + | mkdir -p $(PREFIX)/share/man/man1 | |
| 23 | + | sed "s/VERSION/$(VERSION)/g" dwm.1 > $(PREFIX)/share/man/man1/sxiv.1 | |
| 24 | + | chmod 644 $(PREFIX)/share/man/man1/sxiv.1 | |
| 22 | 25 | ||
| 23 | 26 | clean: | |
| 24 | 27 | rm -f sxiv *.o | |
| @@ -1,5 +1,4 @@ | |||
| 1 | 1 | - mouse scrolling and zooming | |
| 2 | 2 | - add some useful command line options | |
| 3 | − | - write man page | |
| 4 | 3 | - toggle aliasing | |
| 5 | 4 | - view all images in directories (recursive mode) | |
| @@ -154,7 +154,7 @@ void on_keypress(XEvent *ev) { | |||
| 154 | 154 | cleanup(); | |
| 155 | 155 | exit(0); | |
| 156 | 156 | ||
| 157 | − | /* navigate through image list */ | |
| 157 | + | /* navigate image list */ | |
| 158 | 158 | case 'n': | |
| 159 | 159 | if (fileidx + 1 < filecnt) { | |
| 160 | 160 | img_load(&img, filenames[++fileidx]); | |
| @@ -219,7 +219,7 @@ void on_keypress(XEvent *ev) { | |||
| 219 | 219 | changed = img_pan(&img, &win, PAN_RIGHT); | |
| 220 | 220 | break; | |
| 221 | 221 | ||
| 222 | − | /* change window state */ | |
| 222 | + | /* Control window */ | |
| 223 | 223 | case 'f': | |
| 224 | 224 | win_toggle_fullscreen(&win); | |
| 225 | 225 | break; | |
| @@ -0,0 +1,79 @@ | |||
| 1 | + | .TH SXIV 1 sxiv\-VERSION | |
| 2 | + | .SH NAME | |
| 3 | + | sxiv \- Simple (or small or suckless) X Image Viewer | |
| 4 | + | .SH SYNOPSIS | |
| 5 | + | .B sxiv | |
| 6 | + | .RB [ \-hv ] | |
| 7 | + | .SH DESCRIPTION | |
| 8 | + | sxiv is a simple image viewer for X. It only has the most basic features | |
| 9 | + | required for fast image viewing. | |
| 10 | + | .P | |
| 11 | + | Please note, that the fullscreen mode requires an EWMH/NetWM compliant window | |
| 12 | + | manager. | |
| 13 | + | .SH OPTIONS | |
| 14 | + | .TP | |
| 15 | + | .B \-h | |
| 16 | + | Print brief usage information to standard output and exit. | |
| 17 | + | .TP | |
| 18 | + | .B \-v | |
| 19 | + | Print version information to standard output and exit. | |
| 20 | + | .SH KEYBOARD COMMANDS | |
| 21 | + | .SS General | |
| 22 | + | .TP | |
| 23 | + | .B q | |
| 24 | + | Quit sxiv. | |
| 25 | + | .TP | |
| 26 | + | .B Escape | |
| 27 | + | Quit sxiv and return an exit value of 2. | |
| 28 | + | .SS Navigate image list | |
| 29 | + | .TP | |
| 30 | + | .BR Space ", " n | |
| 31 | + | Go to the next image. | |
| 32 | + | .TP | |
| 33 | + | .BR Backspace ", " p | |
| 34 | + | Go to the previous image. | |
| 35 | + | .TP | |
| 36 | + | .B g | |
| 37 | + | Go to the first image. | |
| 38 | + | .TP | |
| 39 | + | .B G | |
| 40 | + | Go to the last image. | |
| 41 | + | .TP | |
| 42 | + | .B [ | |
| 43 | + | Go 10 images backward. | |
| 44 | + | .TP | |
| 45 | + | .B ] | |
| 46 | + | Go 10 images forward. | |
| 47 | + | .SS Zooming | |
| 48 | + | .TP | |
| 49 | + | .BR + ", " = | |
| 50 | + | Zoom in. | |
| 51 | + | .TP | |
| 52 | + | .B \- | |
| 53 | + | Zoom out. | |
| 54 | + | .SS Panning | |
| 55 | + | .TP | |
| 56 | + | .B h | |
| 57 | + | Pan left. | |
| 58 | + | .TP | |
| 59 | + | .B j | |
| 60 | + | Pan down. | |
| 61 | + | .TP | |
| 62 | + | .B k | |
| 63 | + | Pan up. | |
| 64 | + | .TP | |
| 65 | + | .B l | |
| 66 | + | Pan right. | |
| 67 | + | .SS Control window | |
| 68 | + | .TP | |
| 69 | + | .B f | |
| 70 | + | Toggle fullscreen mode. | |
| 71 | + | .SH AUTHORS | |
| 72 | + | .TP | |
| 73 | + | Bert Muennich <ber.t at gmx.com> | |
| 74 | + | .SH MISC | |
| 75 | + | .SS Homepage | |
| 76 | + | .TP | |
| 77 | + | http://github.com/muennich/sxiv | |
| 78 | + | .SH SEE ALSO | |
| 79 | + | .BR feh (1), qiv (1) | |