update manpages

nexdatas · May 12, 2024 · 3216247 · 3216247
1 parent a25f4b0
commit 3216247
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 17 deletions.
diff --git a/man/nxscollect.1 b/man/nxscollect.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "NXSCOLLECT" "1" "May 10, 2024" "4.0" "NXSTools"
+.TH "NXSCOLLECT" "1" "May 12, 2024" "4.0" "NXSTools"
 .SH NAME
 nxscollect \- upload external images into NeXus/HDF5 file
 .SH DESCRIPTION

diff --git a/man/nxsconfig.1 b/man/nxsconfig.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "NXSCONFIG" "1" "May 10, 2024" "4.0" "NXSTools"
+.TH "NXSCONFIG" "1" "May 12, 2024" "4.0" "NXSTools"
 .SH NAME
 nxsconfig \- read NeXus Configuration Server settings
 .SH DESCRIPTION

diff --git a/man/nxscreate.1 b/man/nxscreate.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "NXSCREATE" "1" "May 10, 2024" "4.0" "NXSTools"
+.TH "NXSCREATE" "1" "May 12, 2024" "4.0" "NXSTools"
 .SH NAME
 nxscreate \- create NeXus Configuration component
 .SH DESCRIPTION

diff --git a/man/nxsdata.1 b/man/nxsdata.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "NXSDATA" "1" "May 10, 2024" "4.0" "NXSTools"
+.TH "NXSDATA" "1" "May 12, 2024" "4.0" "NXSTools"
 .SH NAME
 nxsdata \- run NeXus Data Writer
 .SH DESCRIPTION

diff --git a/man/nxsetup.1 b/man/nxsetup.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "NXSETUP" "1" "May 10, 2024" "4.0" "NXSTools"
+.TH "NXSETUP" "1" "May 12, 2024" "4.0" "NXSTools"
 .SH NAME
 nxsetup \- set NeXDaTaS Tango Server environment up
 .SH DESCRIPTION

diff --git a/man/nxsfileinfo.1 b/man/nxsfileinfo.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "NXSFILEINFO" "1" "May 10, 2024" "4.0" "NXSTools"
+.TH "NXSFILEINFO" "1" "May 12, 2024" "4.0" "NXSTools"
 .SH NAME
 nxsfileinfo \- show metadata of the NeXus file
 .SH DESCRIPTION

diff --git a/man/nxstools.1 b/man/nxstools.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "NXSTOOLS" "1" "May 10, 2024" "4.0" "NXSTools"
+.TH "NXSTOOLS" "1" "May 12, 2024" "4.0" "NXSTools"
 .SH NAME
 nxstools \- nxstools Documentation
 .sp
@@ -6302,7 +6302,7 @@ constructor
 .UNINDENT
 .INDENT 0.0
 .TP
-.B class  nxstools.h5rediswriter.H5RedisField(h5object=None, tparent=None, h5imp=None, redis=None)
+.B class  nxstools.h5rediswriter.H5RedisField(h5object=None, tparent=None, h5imp=None)
 Bases: \fI\%H5CppField\fP
 .sp
 file tree file
@@ -6318,8 +6318,6 @@ constructor
 \fBtparent\fP (\fBFTObject\fP) \-\- treee parent
 .IP \(bu 2
 \fBh5imp\fP (\fBfilewriter.FTField\fP) \-\- h5 implementation field
-.IP \(bu 2
-\fBredis\fP (\fI\%any\fP) \-\- redis object
 .UNINDENT
 .UNINDENT
 .INDENT 7.0
@@ -6637,6 +6635,11 @@ scan parameter value
 .UNINDENT
 .INDENT 7.0
 .TP
+.B prepare()
+start scan
+.UNINDENT
+.INDENT 7.0
+.TP
 .B root()
 root object
 .INDENT 7.0
@@ -6734,18 +6737,33 @@ set device info parameters
 .UNINDENT
 .INDENT 7.0
 .TP
-.B set_scan(scan)
-scan object
+.B set_entryname(entryname)
+set entry name
 .INDENT 7.0
 .TP
 .B Parameters
+\fBentryname\fP (\fI\%str\fP) \-\- entry name
+.UNINDENT
+.UNINDENT
 .INDENT 7.0
-.IP \(bu 2
-\fBscan\fP \-\- scan object
-.IP \(bu 2
-\fBtype\fP \-\- \fBScan\fP
+.TP
+.B set_insname(insname)
+set instrument name
+.INDENT 7.0
+.TP
+.B Parameters
+\fBinsname\fP (\fI\%str\fP) \-\- instrument name
 .UNINDENT
 .UNINDENT
+.INDENT 7.0
+.TP
+.B set_scan(scan)
+scan object
+.INDENT 7.0
+.TP
+.B Parameters
+\fBscan\fP (\fBScan\fP) \-\- scan object
+.UNINDENT
 .UNINDENT
 .INDENT 7.0
 .TP
@@ -6772,7 +6790,7 @@ start scan
 .UNINDENT
 .INDENT 0.0
 .TP
-.B class  nxstools.h5rediswriter.H5RedisGroup(h5object=None, tparent=None, h5imp=None, redis=None, nxclass=None)
+.B class  nxstools.h5rediswriter.H5RedisGroup(h5object=None, tparent=None, h5imp=None, nxclass=None)
 Bases: \fI\%H5CppGroup\fP
 .sp
 file tree group
@@ -7111,6 +7129,26 @@ set device parameters
 .UNINDENT
 .INDENT 7.0
 .TP
+.B set_entryname(entryname)
+set entry name
+.INDENT 7.0
+.TP
+.B Parameters
+\fBentryname\fP (\fI\%str\fP) \-\- entry name
+.UNINDENT
+.UNINDENT
+.INDENT 7.0
+.TP
+.B set_insname(insname)
+set instrument name
+.INDENT 7.0
+.TP
+.B Parameters
+\fBinsname\fP (\fI\%str\fP) \-\- instrument name
+.UNINDENT
+.UNINDENT
+.INDENT 7.0
+.TP
 .B set_scan(scan)
 scan object
 .INDENT 7.0