aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornirav <nirav@teisuu.com>2018-09-09 19:52:58 +0530
committerDandelion <nirav@teisuu.com>2018-09-10 01:50:10 +0530
commitff5c3f5ac19a8cf4d4e6fa6a3e4541f3d8d71102 (patch)
tree8d0febeb20d4ea4ab67fc78f78b4773e4af99e62
parent0e18c9651e8a2f01a8ca3fe0fda7c7db7832d5dc (diff)
downloadim-ff5c3f5ac19a8cf4d4e6fa6a3e4541f3d8d71102.tar.gz
im-ff5c3f5ac19a8cf4d4e6fa6a3e4541f3d8d71102.zip
Added manual, updated makefile
-rw-r--r--Makefile11
-rw-r--r--doc/qwe.184
-rw-r--r--doc/qwe.1.scd67
3 files changed, 158 insertions, 4 deletions
diff --git a/Makefile b/Makefile
index d99e7df..12c939f 100644
--- a/Makefile
+++ b/Makefile
@@ -6,8 +6,9 @@ CFLAGS+=-Wall -Wextra -Wno-unused-parameter
CFLAGS+=$(shell pkg-config --cflags gtk+-3.0)
LDFLAGS+=$(shell pkg-config --libs gtk+-3.0)
PREFIX?=/usr
-BINDIR=$(PREFIX)/bin
-APPDIR=$(PREFIX)/share/applications
+BINDIR?=$(PREFIX)/bin
+APPDIR?=$(PREFIX)/share/applications
+MANDIR?=$(PREFIX)/share/man/man1
SRCDIR=src
OUTDIR=build
@@ -33,9 +34,11 @@ clean:
install: qwe qwe.desktop
$(INSTALL) -m0755 qwe $(BINDIR)
$(INSTALL) -m0644 qwe.desktop $(APPDIR)/qwe.desktop
+ $(INSTALL) -m0444 doc/qwe.1 $(MANDIR)/qwe.1
uninstall:
- rm -rf $(BINDIR)/qwe
- rm -rf $(APPDIR)/qwe.desktop
+ rm -f $(BINDIR)/qwe
+ rm -f $(APPDIR)/qwe.desktop
+ rm -f $(MANDIR)/qwe.1
.PHONY: all clean install uninstall
diff --git a/doc/qwe.1 b/doc/qwe.1
new file mode 100644
index 0000000..9e60cf6
--- /dev/null
+++ b/doc/qwe.1
@@ -0,0 +1,84 @@
+.\" Generated by scdoc 1.2.3
+.\" Fix weird quotation marks:
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" Disable hyphenation:
+.nh
+.\" Disable justification:
+.ad l
+.\" Generated content:
+.TH "qwe" "1" "2018-09-09"
+.P
+.SH NAME
+.P
+qwe - a simple image viewer
+.P
+.SH SYNOPSIS
+.P
+\fBqwe\fR \fIfilename\fR
+.P
+.SH DESCRIPTION
+.P
+qwe is a image viewer written in GTK+. It can open any image file
+supported by GdkPixbuf library, use \fB-f\fR flag to print the list of image
+formats supported by GdkPixbuf.
+.P
+.P
+.SH MODES
+.P
+qwe supports two image display modes, \fBFit\fR and \fBZoom\fR.
+.P
+.P
+The default mode \fBFit\fR will resize the image to fit inside the current window
+while maintaining the aspect ratio.
+.P
+.P
+Zoom mode let's you zoom and pan (scroll) the zoomed-in image.
+.P
+.SH KEY BINDINGS
+.P
+qwe has separate key bindings for both \fBFit\fR and \fBZoom\fR mode.
+.P
+.SS FIT MODE
+.P
+.RS "4"
+\fBj\fR, \fBl\fR, \fBn\fR, \fB<Down>\fR, \fB<Right>\fR Next image
+.P
+\fBk\fR, \fBh\fR, \fBp\fR, \fB<Up>\fR, \fB<Left>\fR Previous image
+.P
+.RE
+.SS ZOOM MODE
+.P
+.RS "4"
+\fBj\fR, \fB<Down>\fR Scroll down
+.P
+\fBk\fR, \fB<Up>\fR Scroll up
+.P
+\fBh\fR, \fB<Left>\fR Scroll left
+.P
+\fBl\fR, \fB<Right>\fR Scroll right
+.P
+\fBJ\fR, \fBL\fR, \fB<S-Down>\fR, \fB<S-Right>\fR Next image
+.P
+\fBK\fR, \fBH\fR, \fB<S-Up>\fR, \fB<S-Left>\fR Previous image
+.P
+.RE
+.SS ANY MODE
+.P
+.RS "4"
+\fB+\fR, \fB<C-ScrollWheelUp>\fR Zoom-in by 10% and switch to \fBZoom\fR mode
+.P
+\fB-\fR, \fB<C-ScrollWheelDown>\fR Zoom-out by 10% and switch to \fBZoom\fR mode
+.P
+\fB=\fR Reset zoom to 100% and switch to \fBZoom\fR mode
+.P
+\fBw\fR Switch to \fBFit\fR mode
+.P
+\fBq\fR Quit
+.P
+.RE
+.SH SEE ALSO
+.P
+\fBsxiv\fR(1), \fBfeh\fR(1)
diff --git a/doc/qwe.1.scd b/doc/qwe.1.scd
new file mode 100644
index 0000000..be83cae
--- /dev/null
+++ b/doc/qwe.1.scd
@@ -0,0 +1,67 @@
+qwe(1)
+
+# NAME
+
+qwe - a simple image viewer
+
+# SYNOPSIS
+
+*qwe* _filename_
+
+# DESCRIPTION
+
+qwe is a image viewer written in GTK+. It can open any image file
+supported by GdkPixbuf library, use *-f* flag to print the list of image
+formats supported by GdkPixbuf.
+
+
+# MODES
+
+qwe supports two image display modes, *Fit* and *Zoom*.
+
+
+The default mode *Fit* will resize the image to fit inside the current window
+while maintaining the aspect ratio.
+
+
+Zoom mode let's you zoom and pan (scroll) the zoomed-in image.
+
+# KEY BINDINGS
+
+qwe has separate key bindings for both *Fit* and *Zoom* mode.
+
+## FIT MODE
+
+ *j*, *l*, *n*, *<Down>*, *<Right>* Next image
+
+ *k*, *h*, *p*, *<Up>*, *<Left>* Previous image
+
+## ZOOM MODE
+
+ *j*, *<Down>* Scroll down
+
+ *k*, *<Up>* Scroll up
+
+ *h*, *<Left>* Scroll left
+
+ *l*, *<Right>* Scroll right
+
+ *J*, *L*, *<S-Down>*, *<S-Right>* Next image
+
+ *K*, *H*, *<S-Up>*, *<S-Left>* Previous image
+
+## ANY MODE
+
+ *+*, *<C-ScrollWheelUp>* Zoom-in by 10% and switch to *Zoom* mode
+
+ *-*, *<C-ScrollWheelDown>* Zoom-out by 10% and switch to *Zoom* mode
+
+ *=* Reset zoom to 100% and switch to *Zoom* mode
+
+ *w* Switch to *Fit* mode
+
+ *q* Quit
+
+# SEE ALSO
+
+*sxiv*(1), *feh*(1)