aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2012-02-24 14:05:09 +0100
committerThomas White <taw@physics.org>2012-02-24 14:05:09 +0100
commit77aa89c814cc73dca0dd977910c959bdc8ae0e78 (patch)
tree736183ec8c513f253bab25603751e1dee42ae27a
parent6a974461a612f3e55fd8fa6cecf98ad2e99b6777 (diff)
Add placeholder man pages for everything
-rw-r--r--Makefile.am8
-rw-r--r--doc/man/check_hkl.117
-rw-r--r--doc/man/compare_hkl.117
-rw-r--r--doc/man/crystfel_geometry.12
-rw-r--r--doc/man/get_hkl.117
-rw-r--r--doc/man/hdfsee.117
-rw-r--r--doc/man/indexamajig.12
-rw-r--r--doc/man/partial_sim.117
-rw-r--r--doc/man/partialator.117
-rw-r--r--doc/man/pattern_sim.14
-rw-r--r--doc/man/powder_plot.16
-rw-r--r--doc/man/process_hkl.12
-rw-r--r--doc/man/render_hkl.117
13 files changed, 133 insertions, 10 deletions
diff --git a/Makefile.am b/Makefile.am
index 857a7962..7b94dc3b 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -98,8 +98,12 @@ crystfel_DATA = data/diffraction.cl data/hdfsee.ui
EXTRA_DIST += $(crystfel_DATA)
-man_MANS = doc/man/indexamajig.1 doc/man/process_hkl.1 doc/man/pattern_sim.1 \
- doc/man/crystfel_geometry.1 doc/man/powder_plot.1
+man_MANS = doc/man/check_hkl.1 doc/man/compare_hkl.1 \
+ doc/man/crystfel_geometry.1 doc/man/get_hkl.1 doc/man/hdfsee.1 \
+ doc/man/indexamajig.1 doc/man/partialator.1 doc/man/partial_sim.1 \
+ doc/man/pattern_sim.1 doc/man/powder_plot.1 doc/man/process_hkl.1 \
+ doc/man/render_hkl.1
+
EXTRA_DIST += $(man_MANS)
diff --git a/doc/man/check_hkl.1 b/doc/man/check_hkl.1
new file mode 100644
index 00000000..af830509
--- /dev/null
+++ b/doc/man/check_hkl.1
@@ -0,0 +1,17 @@
+.\"
+.\" check_hkl man page
+.\"
+.\" Copyright © 2012 Thomas White <taw@physics.org>
+.\"
+.\" Part of CrystFEL - crystallography with a FEL
+.\"
+
+.TH CHECK_HKL 1
+.SH NAME
+check_hkl \- calculate figures of merit for reflection data
+.SH SYNOPSIS
+.PP
+.B check_hkl
+[options]
+
+.SH DESCRIPTION
diff --git a/doc/man/compare_hkl.1 b/doc/man/compare_hkl.1
new file mode 100644
index 00000000..3de81a01
--- /dev/null
+++ b/doc/man/compare_hkl.1
@@ -0,0 +1,17 @@
+.\"
+.\" compare_hkl man page
+.\"
+.\" Copyright © 2012 Thomas White <taw@physics.org>
+.\"
+.\" Part of CrystFEL - crystallography with a FEL
+.\"
+
+.TH COMPARE_HKL 1
+.SH NAME
+compare_hkl \- compare reflection data
+.SH SYNOPSIS
+.PP
+.B compare_hkl
+[options]
+
+.SH DESCRIPTION
diff --git a/doc/man/crystfel_geometry.1 b/doc/man/crystfel_geometry.1
index 8a3f0903..708086ff 100644
--- a/doc/man/crystfel_geometry.1
+++ b/doc/man/crystfel_geometry.1
@@ -1,7 +1,7 @@
.\"
.\" Geometry man page
.\"
-.\" (c) 2009-2011 Thomas White <taw@physics.org>
+.\" Copyright © 2012 Thomas White <taw@physics.org>
.\"
.\" Part of CrystFEL - crystallography with a FEL
.\"
diff --git a/doc/man/get_hkl.1 b/doc/man/get_hkl.1
new file mode 100644
index 00000000..6d8bf5aa
--- /dev/null
+++ b/doc/man/get_hkl.1
@@ -0,0 +1,17 @@
+.\"
+.\" get_hkl man page
+.\"
+.\" Copyright © 2012 Thomas White <taw@physics.org>
+.\"
+.\" Part of CrystFEL - crystallography with a FEL
+.\"
+
+.TH GET_HKL 1
+.SH NAME
+get_hkl \- manipulate reflection data
+.SH SYNOPSIS
+.PP
+.B get_hkl
+[options]
+
+.SH DESCRIPTION
diff --git a/doc/man/hdfsee.1 b/doc/man/hdfsee.1
new file mode 100644
index 00000000..15bcdd51
--- /dev/null
+++ b/doc/man/hdfsee.1
@@ -0,0 +1,17 @@
+.\"
+.\" hdfsee man page
+.\"
+.\" Copyright © 2012 Thomas White <taw@physics.org>
+.\"
+.\" Part of CrystFEL - crystallography with a FEL
+.\"
+
+.TH HDFSEE 1
+.SH NAME
+hdfsee \- HDF5 image viewer
+.SH SYNOPSIS
+.PP
+.B hdfsee
+[options]
+
+.SH DESCRIPTION
diff --git a/doc/man/indexamajig.1 b/doc/man/indexamajig.1
index 99503f43..f7a58379 100644
--- a/doc/man/indexamajig.1
+++ b/doc/man/indexamajig.1
@@ -1,7 +1,7 @@
.\"
.\" indexamajig man page
.\"
-.\" (c) 2009-2011 Thomas White <taw@physics.org>
+.\" Copyright © 2012 Thomas White <taw@physics.org>
.\"
.\" Part of CrystFEL - crystallography with a FEL
.\"
diff --git a/doc/man/partial_sim.1 b/doc/man/partial_sim.1
new file mode 100644
index 00000000..6248bb20
--- /dev/null
+++ b/doc/man/partial_sim.1
@@ -0,0 +1,17 @@
+.\"
+.\" partial_sim man page
+.\"
+.\" Copyright © 2012 Thomas White <taw@physics.org>
+.\"
+.\" Part of CrystFEL - crystallography with a FEL
+.\"
+
+.TH PARTIAL_SIM 1
+.SH NAME
+partial_sim \- calculate partial reflections
+.SH SYNOPSIS
+.PP
+.B partial_sim
+[options]
+
+.SH DESCRIPTION
diff --git a/doc/man/partialator.1 b/doc/man/partialator.1
new file mode 100644
index 00000000..49220e4f
--- /dev/null
+++ b/doc/man/partialator.1
@@ -0,0 +1,17 @@
+.\"
+.\" partialator man page
+.\"
+.\" Copyright © 2012 Thomas White <taw@physics.org>
+.\"
+.\" Part of CrystFEL - crystallography with a FEL
+.\"
+
+.TH PARTIALATOR
+.SH NAME
+partialator \- scaling and post-refinement of partial reflections
+.SH SYNOPSIS
+.PP
+.B partialator
+[options]
+
+.SH DESCRIPTION
diff --git a/doc/man/pattern_sim.1 b/doc/man/pattern_sim.1
index 275c25cd..01c6a379 100644
--- a/doc/man/pattern_sim.1
+++ b/doc/man/pattern_sim.1
@@ -1,14 +1,14 @@
.\"
.\" pattern_sim man page
.\"
-.\" (c) 2009-2011 Thomas White <taw@physics.org>
+.\" Copyright © 2012 Thomas White <taw@physics.org>
.\"
.\" Part of CrystFEL - crystallography with a FEL
.\"
.TH PATTERN\_SIM 1
.SH NAME
-pattern\_sim \- Simulation of nanocrystallographic diffraction patterns
+pattern\_sim \- Simulation of nanocrystal diffraction patterns
.SH SYNOPSIS
.PP
.B pattern\_sim
diff --git a/doc/man/powder_plot.1 b/doc/man/powder_plot.1
index 029e3be3..1588ab04 100644
--- a/doc/man/powder_plot.1
+++ b/doc/man/powder_plot.1
@@ -1,7 +1,7 @@
-\" powder_plot man page
+.\" powder_plot man page
.\"
-.\" (c) 2011 Andrew Aquila <andrew.aquila@cfel.de>
-.\" (c) 2009-2011 Thomas White <taw@physics.org>
+.\" Copyright © 2012 Andrew Aquila <andrew.aquila@cfel.de>
+.\" Copyright © 2012 Thomas White <taw@physics.org>
.\"
.\" Part of CrystFEL - crystallography with a FEL
.\"
diff --git a/doc/man/process_hkl.1 b/doc/man/process_hkl.1
index 6c626e31..5e81980d 100644
--- a/doc/man/process_hkl.1
+++ b/doc/man/process_hkl.1
@@ -1,7 +1,7 @@
.\"
.\" process_hkl man page
.\"
-.\" (c) 2009-2011 Thomas White <taw@physics.org>
+.\" Copyright © 2012 Thomas White <taw@physics.org>
.\"
.\" Part of CrystFEL - crystallography with a FEL
.\"
diff --git a/doc/man/render_hkl.1 b/doc/man/render_hkl.1
new file mode 100644
index 00000000..2b206ece
--- /dev/null
+++ b/doc/man/render_hkl.1
@@ -0,0 +1,17 @@
+.\"
+.\" render_hkl man page
+.\"
+.\" Copyright © 2012 Thomas White <taw@physics.org>
+.\"
+.\" Part of CrystFEL - crystallography with a FEL
+.\"
+
+.TH RENDER_HKL 1
+.SH NAME
+render_hkl \- render 2D slices of reciprocal space from reflection data
+.SH SYNOPSIS
+.PP
+.B render_hkl
+[options]
+
+.SH DESCRIPTION