share/man/man1/split.1

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
   4 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH SPLIT 1 "Apr 16, 1999"
  13 .SH NAME
  14 split \- split a file into pieces
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 \fBsplit\fR [\fB-linecount\fR | \fB-l\fR \fIlinecount\fR] [\fB-a\fR \fIsuffixlength\fR]
  19      [\fIfile\fR [\fIname\fR]]
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBsplit\fR [\fB-b\fR \fIn\fR | \fIn\fRk | \fIn\fRm] [\fB-a\fR \fIsuffixlength\fR] [\fIfile\fR [\fIname\fR]]
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 The \fBsplit\fR utility reads \fIfile\fR and writes it in \fIlinecount\fR-line
  31 pieces into a set of output-files. The name of the first output-file is
  32 \fIname\fR with \fBaa\fR appended, and so on lexicographically, up to \fBzz\fR
  33 (a maximum of 676 files). The maximum length of \fIname\fR is 2 characters less
  34 than the maximum filename length allowed by the filesystem. See
  35 \fBstatvfs\fR(2). If no output name is given, \fBx\fR is used as the default
  36 (output-files will be called \fBxaa\fR, \fBxab\fR, and so forth).
  37 .SH OPTIONS
  38 .sp
  39 .LP
  40 The following options are supported:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fB\(mi\fR\fIlinecount\fR \fB|\fR \fB-l\fR \fIlinecount\fR\fR
  45 .ad
  46 .sp .6
  47 .RS 4n
  48 Number of lines in each piece. Defaults to \fB1000\fR lines.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fB-a\fR \fIsuffixlength\fR\fR
  55 .ad
  56 .sp .6
  57 .RS 4n
  58 Uses \fIsuffixlength\fR letters to form the suffix portion of the filenames of
  59 the split file. If \fB-a\fR is not specified, the default suffix length is
  60 \fB2\fR. If the sum of the \fIname\fR operand and the \fIsuffixlength\fR
  61 option-argument would create a filename exceeding \fINAME_MAX\fR bytes, an
  62 error will result; \fBsplit\fR will exit with a diagnostic message and no files
  63 will be created.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fB-b\fR \fIn\fR\fR
  70 .ad
  71 .sp .6
  72 .RS 4n
  73 Splits a file into pieces \fIn\fR bytes in size.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fB-b\fR \fIn\fR\fBk\fR\fR
  80 .ad
  81 .sp .6
  82 .RS 4n
  83 Splits a file into pieces \fIn\fR\fB*1024\fR bytes in size.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB-b\fR \fIn\fR\fBm\fR\fR
  90 .ad
  91 .sp .6
  92 .RS 4n
  93 Splits a file into pieces \fIn\fR\fB*1\|048\|576\fR bytes in size.
  94 .RE
  95
  96 .SH OPERANDS
  97 .sp
  98 .LP
  99 The following operands are supported:
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fIfile\fR\fR
 104 .ad
 105 .RS 8n
 106 The path name of the ordinary file to be split. If no input file is given or
 107 \fIfile\fR is \fB\(mi\fR, the standard input will be used.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fIname\fR\fR
 114 .ad
 115 .RS 8n
 116 The prefix to be used for each of the files resulting from the \fBsplit\fR
 117 operation. If no \fIname\fR argument is given, \fBx\fR will be used as the
 118 prefix of the output files. The combined length of the basename of \fIprefix\fR
 119 and \fIsuffixlength\fR cannot exceed \fINAME_MAX\fR bytes. See OPTIONS.
 120 .RE
 121
 122 .SH USAGE
 123 .sp
 124 .LP
 125 See \fBlargefile\fR(5) for the description of the behavior of \fBsplit\fR when
 126 encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
 127 .SH ENVIRONMENT VARIABLES
 128 .sp
 129 .LP
 130 See \fBenviron\fR(5) for descriptions of the following environment variables
 131 that affect the execution of \fBsplit\fR: \fBLANG\fR, \fBLC_ALL\fR,
 132 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
 133 .SH EXIT STATUS
 134 .sp
 135 .LP
 136 The following exit values are returned:
 137 .sp
 138 .ne 2
 139 .na
 140 \fB\fB0\fR\fR
 141 .ad
 142 .RS 6n
 143 Successful completion.
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fB>0\fR\fR
 150 .ad
 151 .RS 6n
 152 An error occurred.
 153 .RE
 154
 155 .SH ATTRIBUTES
 156 .sp
 157 .LP
 158 See \fBattributes\fR(5) for descriptions of the following attributes:
 159 .sp
 160
 161 .sp
 162 .TS
 163 box;
 164 c | c
 165 l | l .
 166 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 167 _
 168 CSI     Enabled
 169 _
 170 Interface Stability     Committed
 171 _
 172 Standard        See  \fBstandards\fR(5).
 173 .TE
 174
 175 .SH SEE ALSO
 176 .sp
 177 .LP
 178 \fBcsplit\fR(1), \fBstatvfs\fR(2), \fBattributes\fR(5), \fBenviron\fR(5),
 179 \fBlargefile\fR(5), \fBstandards\fR(5)