aboutsummaryrefslogtreecommitdiff
path: root/pkg/utilities/doc/split.hlp
diff options
context:
space:
mode:
authorJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
committerJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
commit40e5a5811c6ffce9b0974e93cdd927cbcf60c157 (patch)
tree4464880c571602d54f6ae114729bf62a89518057 /pkg/utilities/doc/split.hlp
downloadiraf-osx-40e5a5811c6ffce9b0974e93cdd927cbcf60c157.tar.gz
Repatch (from linux) of OSX IRAF
Diffstat (limited to 'pkg/utilities/doc/split.hlp')
-rw-r--r--pkg/utilities/doc/split.hlp59
1 files changed, 59 insertions, 0 deletions
diff --git a/pkg/utilities/doc/split.hlp b/pkg/utilities/doc/split.hlp
new file mode 100644
index 00000000..e398fe3d
--- /dev/null
+++ b/pkg/utilities/doc/split.hlp
@@ -0,0 +1,59 @@
+.help split Sep86 utilities
+.ih
+NAME
+split -- split a large file into smaller segments
+.ih
+USAGE
+split input output
+.ih
+PARAMETERS
+.ls input
+The name of the input file (only a single file can be processed).
+.le
+.ls output
+The root name of the output files.
+.le
+.ls nlines = 1000
+The maximum number of lines per output segment file, if the input file
+is a text file.
+.le
+.ls nbytes = 16384
+The maximum number of bytes per output segment file, if the input file
+is a binary file.
+.le
+.ls maxfiles = 999
+Maximum number of output files. Used to determine the amount of zero
+padding needed for the filename extensions.
+.le
+.ls verbose = yes
+Print the name and size of each output file as it is generated.
+.le
+.ih
+DESCRIPTION
+The \fIsplit\fR task is used to break large files up into smaller segments,
+e.g., when it is necessary to deal with an unmanageably large file.
+Lacking any knowledge of the file structure, the segments are broken on
+arbitrarily located but equally spaced boundaries. The segments may
+subsequently be reassembled into larger segments of the original file with
+\fIconcatenate\fR or \fIcopy\fR (with output redirection), or \fIsplit\fR may
+be applied again to break a large segment up into smaller segments without
+losing any information.
+.ih
+EXAMPLES
+1. Split a large text file into segments, each of which is the default size.
+
+ cl> split textfile seg
+
+2. Split a large \fItar\fR format archive file (10240 byte records) up into
+a series of smaller files, each of which contains 10 records from the input
+tar file.
+
+ cl> split big.arc seg nb=(10240*10)
+
+.ih
+TIME REQUIREMENTS
+very fast
+.ih
+SEE ALSO
+concatenate, copy
+.endhelp