summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJerome Pinot <ngc891@gmail.com>2013-11-06 21:11:30 +0900
committerJerome Pinot <ngc891@gmail.com>2013-11-06 21:11:30 +0900
commit19ad927e091886e74b1a6b57049bb8035e26c278 (patch)
tree1da093eb9bacc17326a371ad618ccdf215663e21
parent9e8a61347259fb8279ac7debfa150fb7feeac4af (diff)
Add a man page.
-rw-r--r--Makefile.am2
-rw-r--r--configure.ac3
-rw-r--r--doc/Makefile.am4
-rw-r--r--doc/efractal.173
4 files changed, 80 insertions, 2 deletions
diff --git a/Makefile.am b/Makefile.am
index 6d8f864..eb6dfc1 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -20,7 +20,7 @@ MAINTAINERCLEANFILES = \
20 $(PACKAGE_TARNAME)-$(PACKAGE_VERSION).tar.gz \ 20 $(PACKAGE_TARNAME)-$(PACKAGE_VERSION).tar.gz \
21 $(PACKAGE_TARNAME)-$(PACKAGE_VERSION).tar.bz2 21 $(PACKAGE_TARNAME)-$(PACKAGE_VERSION).tar.bz2
22 22
23SUBDIRS = data src 23SUBDIRS = data doc src
24 24
25ACLOCAL_AMFLAGS = -I m4 25ACLOCAL_AMFLAGS = -I m4
26 26
diff --git a/configure.ac b/configure.ac
index bd503a7..8ebdf20 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1,4 +1,4 @@
1AC_INIT([efractal], [m4_esyscmd([cat VERSION | tr -d '\n'])], [ngc891@gmail.com]) 1AC_INIT([efractal], m4_esyscmd([tr -d '\n' < VERSION]), [ngc891@gmail.com])
2AC_PREREQ([2.69]) 2AC_PREREQ([2.69])
3AC_CONFIG_SRCDIR([config.h.in]) 3AC_CONFIG_SRCDIR([config.h.in])
4AC_CONFIG_HEADERS([config.h]) 4AC_CONFIG_HEADERS([config.h])
@@ -51,6 +51,7 @@ Makefile
51data/Makefile 51data/Makefile
52data/desktop/Makefile 52data/desktop/Makefile
53data/maps/Makefile 53data/maps/Makefile
54doc/Makefile
54src/Makefile 55src/Makefile
55]) 56])
56AC_OUTPUT 57AC_OUTPUT
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..8b08ba5
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,4 @@
1MAINTAINERCLEANFILES = Makefile.in
2EXTRA_DIST = efractal.1
3
4man_MANS = efractal.1
diff --git a/doc/efractal.1 b/doc/efractal.1
new file mode 100644
index 0000000..24ed174
--- /dev/null
+++ b/doc/efractal.1
@@ -0,0 +1,73 @@
1.TH EFTRACTAL 1 "06 Nov 2013" "efractal 0.1"
2
3.SH NAME
4efractal \- an EFL fractal explorer
5
6.SH SYNOPSIS
7.B efractal
8[-h] [-l] [-s SET] [-t THEME] [-V]
9
10.SH DESCRIPTION
11
12eFractal shows graphical representation of some common fractals.
13
14With no option, the program displays the Mandelbrot set with the cubehelix color map.
15
16
17.SH CONTROLS
18
19.TP
20.I Left Mouse Button
21Zoom in.
22
23.TP
24.I Right Mouse Button
25Zoom out.
26
27
28.SH OPTIONS
29
30.TP
31.I -C, --copyright
32Print license information.
33
34.TP
35.I -h, --help
36Print list of options with short description and exit.
37
38.TP
39.I -l, --list
40List available colors maps
41
42.TP
43.I -s SET, --set=SET
44Specify the fractal formula. Can be one of:
45
46.I julia
47.I mandelbrot
48.I mandelbrot3
49.I mandelbrot4
50
51.TP
52.I -t THEME
53Use THEME as color map. Color map files must be in the $(datarootdir)/efractal/maps
54folder with the `.map' extension. Use option `-l' to print a list of available color maps.
55
56.TP
57.I -V, --version
58Print version informations and exit.
59
60
61.SH BUGS
62
63Reports are welcome.
64
65
66.SH HOMEPAGE
67
68http://efracatl.sourceforge.net
69
70
71.SH AUTHOR
72
73Jerome Pinot <ngc891@gmail.com>