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