6/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 August 9, 2006
  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 .Op Fl l Ar line_count
  44 .Op Fl a Ar suffix_length
  45 .Op Ar file Op Ar prefix
  46 .Nm
  47 .Fl b Ar byte_count Ns
  48 .Oo
  49 .Cm k Ns | Ns Cm m
  50 .Oc
  51 .Op Fl a Ar suffix_length
  52 .Op Ar file Op Ar prefix
  53 .Nm
  54 .Fl p Ar pattern
  55 .Op Fl a Ar suffix_length
  56 .Op Ar file Op Ar prefix
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 utility reads the given
  61 .Ar file
  62 and breaks it up into files of 1000 lines each
  63 (if no options are specified), leaving the
  64 .Ar file
  65 unchanged.
  66 If
  67 .Ar file
  68 is a single dash
  69 .Pq Sq Fl
  70 or absent,
  71 .Nm
  72 reads from the standard input.
  73 .Pp
  74 The options are as follows:
  75 .Bl -tag -width indent
  76 .It Fl a
  77 Use
  78 .Ar suffix_length
  79 letters to form the suffix of the file name.
  80 .It Fl b
  81 Create smaller files
  82 .Ar byte_count
  83 bytes in length.
  84 If
  85 .Dq Li k
  86 is appended to the number, the file is split into
  87 .Ar byte_count
  88 kilobyte pieces.
  89 If
  90 .Dq Li m
  91 is appended to the number, the file is split into
  92 .Ar byte_count
  93 megabyte pieces.
  94 .It Fl l
  95 Create smaller files
  96 .Ar line_count
  97 lines in length.
  98 .It Fl p Ar pattern
  99 The file is split whenever an input line matches
 100 .Ar pattern ,
 101 which is interpreted as an extended regular expression.
 102 The matching line will be the first line of the next output file.
 103 This option is incompatible with the
 104 .Fl b
 105 and
 106 .Fl l
 107 options.
 108 .El
 109 .Pp
 110 If additional arguments are specified, the first is used as the name
 111 of the input file which is to be split.
 112 If a second additional argument is specified, it is used as a prefix
 113 for the names of the files into which the file is split.
 114 In this case, each file into which the file is split is named by the
 115 prefix followed by a lexically ordered suffix using
 116 .Ar suffix_length
 117 characters in the range
 118 .Dq Li a Ns  - Ns Li z .
 119 If
 120 .Fl a
 121 is not specified, two letters are used as the suffix.
 122 .Pp
 123 If the
 124 .Ar prefix
 125 argument is not specified, the file is split into lexically ordered
 126 files named with prefixes in the range of
 127 .Dq Li x-z
 128 and with suffixes as above.
 129 .Sh ENVIRONMENT
 130 The
 131 .Ev LANG , LC_ALL , LC_CTYPE
 132 and
 133 .Ev LC_COLLATE
 134 environment variables affect the execution of
 135 .Nm
 136 as described in
 137 .Xr environ 7 .
 138 .Sh EXIT STATUS
 139 .Ex -std
 140 .Sh SEE ALSO
 141 .Xr csplit 1 ,
 142 .Xr re_format 7
 143 .Sh STANDARDS
 144 The
 145 .Nm
 146 utility conforms to
 147 .St -p1003.1-2001 .
 148 .Sh HISTORY
 149 A
 150 .Nm
 151 command appeared in
 152 .At v3 .
 153 .Sh BUGS
 154 For historical reasons, if you specify
 155 .Ar name ,
 156 .Nm
 157 can only create 676 separate
 158 files.
 159 The default naming convention allows 2028 separate files.
 160 The
 161 .Fl a
 162 option can be used to work around this limitation.
 163 .Pp
 164 The maximum line length for matching patterns is 65536.