usr.bin/split/split.1

   1 .\" Copyright (c) 1990, 1991, 1993, 1994
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)split.1     8.3 (Berkeley) 4/16/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd May 26, 2023
  32 .Dt SPLIT 1
  33 .Os
  34 .Sh NAME
  35 .Nm split
  36 .Nd split a file into pieces
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl cd
  40 .Op Fl l Ar line_count
  41 .Op Fl a Ar suffix_length
  42 .Op Ar file Op Ar prefix
  43 .Nm
  44 .Op Fl cd
  45 .Fl b Ar byte_count Ns
  46 .Oo
  47 .Sm off
  48 .Cm K | k | M | m | G | g
  49 .Sm on
  50 .Oc
  51 .Op Fl a Ar suffix_length
  52 .Op Ar file Op Ar prefix
  53 .Nm
  54 .Op Fl cd
  55 .Fl n Ar chunk_count
  56 .Op Fl a Ar suffix_length
  57 .Op Ar file Op Ar prefix
  58 .Nm
  59 .Op Fl cd
  60 .Fl p Ar pattern
  61 .Op Fl a Ar suffix_length
  62 .Op Ar file Op Ar prefix
  63 .Sh DESCRIPTION
  64 The
  65 .Nm
  66 utility reads the given
  67 .Ar file
  68 and breaks it up into files of 1000 lines each
  69 (if no options are specified), leaving the
  70 .Ar file
  71 unchanged.
  72 If
  73 .Ar file
  74 is a single dash
  75 .Pq Sq Fl
  76 or absent,
  77 .Nm
  78 reads from the standard input.
  79 .Pp
  80 The options are as follows:
  81 .Bl -tag -width indent
  82 .It Fl a Ar suffix_length
  83 Use
  84 .Ar suffix_length
  85 letters to form the suffix of the file name.
  86 .It Fl b Ar byte_count Ns Oo
  87 .Sm off
  88 .Cm K | k | M | m | G | g
  89 .Sm on
  90 .Oc
  91 Create split files
  92 .Ar byte_count
  93 bytes in length.
  94 If
  95 .Cm k
  96 or
  97 .Cm K
  98 is appended to the number, the file is split into
  99 .Ar byte_count
 100 kilobyte pieces.
 101 If
 102 .Cm m
 103 or
 104 .Cm M
 105 is appended to the number, the file is split into
 106 .Ar byte_count
 107 megabyte pieces.
 108 If
 109 .Cm g
 110 or
 111 .Cm G
 112 is appended to the number, the file is split into
 113 .Ar byte_count
 114 gigabyte pieces.
 115 .It Fl c
 116 Continue creating files and do not overwrite existing
 117 output files.
 118 .It Fl d
 119 Use a numeric suffix instead of a alphabetic suffix.
 120 .It Fl l Ar line_count
 121 Create split files
 122 .Ar line_count
 123 lines in length.
 124 .It Fl n Ar chunk_count
 125 Split file into
 126 .Ar chunk_count
 127 smaller files.
 128 The first n - 1 files will be of size (size of
 129 .Ar file
 130 /
 131 .Ar chunk_count
 132 )
 133 and the last file will contain the remaining bytes.
 134 .It Fl p Ar pattern
 135 The file is split whenever an input line matches
 136 .Ar pattern ,
 137 which is interpreted as an extended regular expression.
 138 The matching line will be the first line of the next output file.
 139 This option is incompatible with the
 140 .Fl b
 141 and
 142 .Fl l
 143 options.
 144 .El
 145 .Pp
 146 If additional arguments are specified, the first is used as the name
 147 of the input file which is to be split.
 148 If a second additional argument is specified, it is used as a prefix
 149 for the names of the files into which the file is split.
 150 In this case, each file into which the file is split is named by the
 151 prefix followed by a lexically ordered suffix using
 152 .Ar suffix_length
 153 characters in the range
 154 .Dq Li a Ns - Ns Li z .
 155 If
 156 .Fl a
 157 is not specified, two letters are used as the initial suffix.
 158 If the output does not fit into the resulting number of files and the
 159 .Fl d
 160 flag is not specified, then the suffix length is automatically extended as
 161 needed such that all output files continue to sort in lexical order.
 162 .Pp
 163 If the
 164 .Ar prefix
 165 argument is not specified, the file is split into lexically ordered
 166 files named with the prefix
 167 .Dq Li x
 168 and with suffixes as above.
 169 .Pp
 170 By default,
 171 .Nm
 172 will overwrite any existing output files.
 173 If the
 174 .Fl c
 175 flag is specified,
 176 .Nm
 177 will instead create files with names that do not already exist.
 178 .Sh ENVIRONMENT
 179 The
 180 .Ev LANG , LC_ALL , LC_CTYPE
 181 and
 182 .Ev LC_COLLATE
 183 environment variables affect the execution of
 184 .Nm
 185 as described in
 186 .Xr environ 7 .
 187 .Sh EXIT STATUS
 188 .Ex -std
 189 .Sh EXAMPLES
 190 Split input into as many files as needed, so that each file contains at most 2
 191 lines:
 192 .Bd -literal -offset indent
 193 $ echo -e "first line\\nsecond line\\nthird line\\nforth line" | split -l2
 194 .Ed
 195 .Pp
 196 Split input in chunks of 10 bytes using numeric prefixes for file names.
 197 This generates two files of 10 bytes (x00 and x01) and a third file (x02) with the
 198 remaining 2 bytes:
 199 .Bd -literal -offset indent
 200 $ echo -e "This is 22 bytes long" | split -d -b10
 201 .Ed
 202 .Pp
 203 Split input generating 6 files:
 204 .Bd -literal -offset indent
 205 $ echo -e "This is 22 bytes long" | split -n 6
 206 .Ed
 207 .Pp
 208 Split input creating a new file every time a line matches the regular expression
 209 for a
 210 .Dq t
 211 followed by either
 212 .Dq a
 213 or
 214 .Dq u
 215 thus creating two files:
 216 .Bd -literal -offset indent
 217 $ echo -e "stack\\nstock\\nstuck\\nanother line" | split -p 't[au]'
 218 .Ed
 219 .Sh SEE ALSO
 220 .Xr csplit 1 ,
 221 .Xr re_format 7
 222 .Sh STANDARDS
 223 The
 224 .Nm
 225 utility conforms to
 226 .St -p1003.1-2001 .
 227 .Sh HISTORY
 228 A
 229 .Nm
 230 command appeared in
 231 .At v3 .
 232 .Pp
 233 Before
 234 .Fx 14 ,
 235 pattern and line matching only operated on lines shorter than 65,536 bytes.