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