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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)split.1     8.3 (Berkeley) 4/16/94
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd May 9, 2013
  36 .Dt SPLIT 1
  37 .Os
  38 .Sh NAME
  39 .Nm split
  40 .Nd split a file into pieces
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Fl d
  44 .Op Fl l Ar line_count
  45 .Op Fl a Ar suffix_length
  46 .Op Ar file Op Ar prefix
  47 .Nm
  48 .Fl d
  49 .Fl b Ar byte_count Ns
  50 .Oo
  51 .Sm off
  52 .Cm K | k | M | m | G | g
  53 .Sm on
  54 .Oc
  55 .Op Fl a Ar suffix_length
  56 .Op Ar file Op Ar prefix
  57 .Nm
  58 .Fl d
  59 .Fl n Ar chunk_count
  60 .Op Fl a Ar suffix_length
  61 .Op Ar file Op Ar prefix
  62 .Nm
  63 .Fl d
  64 .Fl p Ar pattern
  65 .Op Fl a Ar suffix_length
  66 .Op Ar file Op Ar prefix
  67 .Sh DESCRIPTION
  68 The
  69 .Nm
  70 utility reads the given
  71 .Ar file
  72 and breaks it up into files of 1000 lines each
  73 (if no options are specified), leaving the
  74 .Ar file
  75 unchanged.
  76 If
  77 .Ar file
  78 is a single dash
  79 .Pq Sq Fl
  80 or absent,
  81 .Nm
  82 reads from the standard input.
  83 .Pp
  84 The options are as follows:
  85 .Bl -tag -width indent
  86 .It Fl a Ar suffix_length
  87 Use
  88 .Ar suffix_length
  89 letters to form the suffix of the file name.
  90 .It Fl b Ar byte_count Ns Oo
  91 .Sm off
  92 .Cm K | k | M | m | G | g
  93 .Sm on
  94 .Oc
  95 Create split files
  96 .Ar byte_count
  97 bytes in length.
  98 If
  99 .Cm k
 100 or
 101 .Cm K
 102 is appended to the number, the file is split into
 103 .Ar byte_count
 104 kilobyte pieces.
 105 If
 106 .Cm m
 107 or
 108 .Cm M
 109 is appended to the number, the file is split into
 110 .Ar byte_count
 111 megabyte pieces.
 112 If
 113 .Cm g
 114 or
 115 .Cm G
 116 is appended to the number, the file is split into
 117 .Ar byte_count
 118 gigabyte pieces.
 119 .It Fl d
 120 Use a numeric suffix instead of a alphabetic suffix.
 121 .It Fl l Ar line_count
 122 Create split files
 123 .Ar line_count
 124 lines in length.
 125 .It Fl n Ar chunk_count
 126 Split file into
 127 .Ar chunk_count
 128 smaller files.
 129 .It Fl p Ar pattern
 130 The file is split whenever an input line matches
 131 .Ar pattern ,
 132 which is interpreted as an extended regular expression.
 133 The matching line will be the first line of the next output file.
 134 This option is incompatible with the
 135 .Fl b
 136 and
 137 .Fl l
 138 options.
 139 .El
 140 .Pp
 141 If additional arguments are specified, the first is used as the name
 142 of the input file which is to be split.
 143 If a second additional argument is specified, it is used as a prefix
 144 for the names of the files into which the file is split.
 145 In this case, each file into which the file is split is named by the
 146 prefix followed by a lexically ordered suffix using
 147 .Ar suffix_length
 148 characters in the range
 149 .Dq Li a Ns - Ns Li z .
 150 If
 151 .Fl a
 152 is not specified, two letters are used as the suffix.
 153 .Pp
 154 If the
 155 .Ar prefix
 156 argument is not specified, the file is split into lexically ordered
 157 files named with the prefix
 158 .Dq Li x
 159 and with suffixes as above.
 160 .Sh ENVIRONMENT
 161 The
 162 .Ev LANG , LC_ALL , LC_CTYPE
 163 and
 164 .Ev LC_COLLATE
 165 environment variables affect the execution of
 166 .Nm
 167 as described in
 168 .Xr environ 7 .
 169 .Sh EXIT STATUS
 170 .Ex -std
 171 .Sh SEE ALSO
 172 .Xr csplit 1 ,
 173 .Xr re_format 7
 174 .Sh STANDARDS
 175 The
 176 .Nm
 177 utility conforms to
 178 .St -p1003.1-2001 .
 179 .Sh HISTORY
 180 A
 181 .Nm
 182 command appeared in
 183 .At v3 .
 184 .Sh BUGS
 185 The maximum line length for matching patterns is 65536.