aboutsummaryrefslogtreecommitdiff
path: root/doc/man/indexamajig.1
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2012-04-26 14:08:12 +0200
committerThomas White <taw@physics.org>2012-04-26 14:08:12 +0200
commitcfbbdae0ff6b0823fd9de0971f51b9fd939db5b6 (patch)
tree7167d52829efec8c6292e7c75e11add57c3ef5f1 /doc/man/indexamajig.1
parentd7ff5c5ab2ffdaa2808d5e336603804450ca15b0 (diff)
indexamajig: Make --no-closer-peak the default
Diffstat (limited to 'doc/man/indexamajig.1')
-rw-r--r--doc/man/indexamajig.111
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/man/indexamajig.1 b/doc/man/indexamajig.1
index ac443906..6d28fdc4 100644
--- a/doc/man/indexamajig.1
+++ b/doc/man/indexamajig.1
@@ -296,9 +296,18 @@ Run \fIn\fR analyses in parallel. Default: 1.
Don't attempt to correct the prefix (see \fB--prefix\fR) if it doesn't look correct.
.PD 0
+.IP \fB--closer-peak\fR
+.PD
+If you use this option, indexamajig will integrate around the location of a detected peak instead of the predicted peak location if one is found close to the predicted position, within ten pixels. \fBDon't use this option\fR, because
+there is currently no way to set the definition of 'nearby' to be appropriate
+for your data.
+
+.PD 0
.IP \fB--no-closer-peak\fR
.PD
-Normally, indexamajig will integrate around the location of a detected peak instead of the predicted peak location if one is found close to the predicted position. This option disables this behaviour. Normally it doesn't make much difference either way.
+This is the opposite of \fB--closer-peak\fR, and is provided for compatibility
+with old scripts because this option selects the behaviour which is now the
+default.
.PD 0
.IP \fB--insane\fR