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