Commit 6c2a86fd authored by Thomas White's avatar Thomas White
Browse files

render_hkl: Update docs

parent 84e676ef
...@@ -32,6 +32,13 @@ Specify the indices for the downward direction of the resulting plot. Default: ...@@ -32,6 +32,13 @@ Specify the indices for the downward direction of the resulting plot. Default:
.PD .PD
Specify the indices for the 'right' direction of the resulting plot. The direction will be approximately to the right, the exact direction depending on the unit cell. Default: \fB--right=0,1,0\fR. Specify the indices for the 'right' direction of the resulting plot. The direction will be approximately to the right, the exact direction depending on the unit cell. Default: \fB--right=0,1,0\fR.
.PD 0
.IP "\fB--zone=\fR\fIz\fR
.PD
Show reflections for which \fBg\fR.\fBr\fR=\fIz\fR, where \fBg\fR is the
reflection index (i.e. hkl) and \fBr\fR is the zone axis direction. \fIz\fR
hence represents the Laue zone number.
.PD 0 .PD 0
.IP "\fB-o\fR \fIfilename\fR" .IP "\fB-o\fR \fIfilename\fR"
.IP \fB--output=\fR\fIfilename\fR .IP \fB--output=\fR\fIfilename\fR
......
...@@ -64,6 +64,7 @@ static void show_help(const char *s) ...@@ -64,6 +64,7 @@ static void show_help(const char *s)
" Default: 1,0,0.\n" " Default: 1,0,0.\n"
" -r, --right=<h>,<k>,<l> Indices for the axis in the 'right' (roughly)\n" " -r, --right=<h>,<k>,<l> Indices for the axis in the 'right' (roughly)\n"
" direction. Default: 0,1,0.\n" " direction. Default: 0,1,0.\n"
" --zone=<z> Show the <z>th Laue zone.\n"
" -o, --output=<filename> Output filename. Default: za.pdf\n" " -o, --output=<filename> Output filename. Default: za.pdf\n"
" --boost=<val> Squash colour scale by <val>.\n" " --boost=<val> Squash colour scale by <val>.\n"
" -p, --pdb=<file> PDB file from which to get the unit cell.\n" " -p, --pdb=<file> PDB file from which to get the unit cell.\n"
...@@ -79,8 +80,9 @@ static void show_help(const char *s) ...@@ -79,8 +80,9 @@ static void show_help(const char *s)
" according to:\n" " according to:\n"
" I : the intensity of the reflection.\n" " I : the intensity of the reflection.\n"
" sqrtI : the square root of the intensity.\n" " sqrtI : the square root of the intensity.\n"
" count : the number of measurements for the reflection.\n" " count : the number of measurements for the\n"
" (after correcting for 'epsilon')\n" " reflection (after correcting for\n"
" multiplicity 'epsilon').\n"
" rawcts : the raw number of measurements for the\n" " rawcts : the raw number of measurements for the\n"
" reflection (no 'epsilon' correction).\n" " reflection (no 'epsilon' correction).\n"
"\n" "\n"
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment