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