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