aboutsummaryrefslogtreecommitdiff
path: root/pkg/plot/doc/gkiextract.hlp
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
committerJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
commitfa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 (patch)
treebdda434976bc09c864f2e4fa6f16ba1952b1e555 /pkg/plot/doc/gkiextract.hlp
downloadiraf-linux-fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4.tar.gz
Initial commit
Diffstat (limited to 'pkg/plot/doc/gkiextract.hlp')
-rw-r--r--pkg/plot/doc/gkiextract.hlp45
1 files changed, 45 insertions, 0 deletions
diff --git a/pkg/plot/doc/gkiextract.hlp b/pkg/plot/doc/gkiextract.hlp
new file mode 100644
index 00000000..22b51318
--- /dev/null
+++ b/pkg/plot/doc/gkiextract.hlp
@@ -0,0 +1,45 @@
+.help gkiextract Jan86 plot
+.ih
+NAME
+gkiextract -- extract individual frames from a GKI metacode file
+.ih
+USAGE
+gkiextract input frames
+.ih
+PARAMETERS
+.ls input
+The metacode source file or files.
+.le
+.ls frames
+List of frames to be extracted from each metacode file.
+.le
+.ls verify = no
+Verify each frame before extraction?
+.le
+.ih
+DESCRIPTION
+Task \fBgkiextract\fR will extract individual frames from a metacode file,
+writing a binary metacode output stream which can be piped to a kernel
+for plotting or redirected to produce a new metacode file.
+Parameter \fIframes\fR specifies a list of frames to be
+extracted from each input file. If \fIverify\fR = yes,
+a \fBgkidir\fR style line will be printed for each specified frame
+and the user will be queried whether or not to extract the frame.
+.ih
+EXAMPLES
+1. Extract frames 1, 3 and 5 from metacode file "mc_file" and
+plot them on the device "vup":
+
+ cl> gkiextract mc_file 1,3,5 | stdplot dev=vup
+
+2. Print a directory of the first 99 frames in "mc_file", extract
+those files requested by the user and write them to file "new_mc_file".
+
+ cl> gkiextract mc_file 1-99 ver+ > new_mc_file
+.ih
+BUGS
+A maximum of 8192 plots in a single metacode file may be processed.
+.ih
+SEE ALSO
+gkidir
+.endhelp