xref: /dragonfly/usr.bin/split/split.1 (revision 2cd2d2b5)
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: src/usr.bin/split/split.1,v 1.3.2.6 2003/04/21 21:16:25 andreas Exp $
34.\" $DragonFly: src/usr.bin/split/split.1,v 1.2 2003/06/17 04:29:31 dillon Exp $
35.\"
36.Dd April 16, 1994
37.Dt SPLIT 1
38.Os
39.Sh NAME
40.Nm split
41.Nd split a file into pieces
42.Sh SYNOPSIS
43.Nm
44.Op Fl a Ar suffix_length
45.Op Fl b Ar byte_count[k|m]
46.Op Fl l Ar line_count
47.Op Fl p Ar pattern
48.Op Ar file Op Ar name
49.Sh DESCRIPTION
50The
51.Nm
52utility reads the given
53.Ar file
54and breaks it up into files of 1000 lines each.
55If
56.Ar file
57is a single dash
58.Pq Sq Fl
59or absent,
60.Nm
61reads from the standard input.
62.Pp
63The options are as follows:
64.Bl -tag -width Ds
65.It Fl a
66Use
67.Ar suffix_length
68letters to form the suffix of the file name.
69.It Fl b
70Create smaller files
71.Ar byte_count
72bytes in length.
73If
74.Dq Li k
75is appended to the number, the file is split into
76.Ar byte_count
77kilobyte pieces.
78If
79.Dq Li m
80is appended to the number, the file is split into
81.Ar byte_count
82megabyte pieces.
83.It Fl l
84Create smaller files
85.Ar n
86lines in length.
87.It Fl p Ar pattern
88The file is split whenever an input line matches
89.Ar pattern ,
90which is interpreted as an extended regular expression.
91The matching line will be the first line of the next output file.
92This option is incompatible with the
93.Fl b
94and
95.Fl l
96options.
97.El
98.Pp
99If additional arguments are specified, the first is used as the name
100of the input file which is to be split.
101If a second additional argument is specified, it is used as a prefix
102for the names of the files into which the file is split.
103In this case, each file into which the file is split is named by the
104prefix followed by a lexically ordered suffix using
105.Ar suffix_length
106characters in the range
107.Dq Li a-z .
108If
109.Fl a
110is not specified, two letters are used as the suffix.
111.Pp
112If the
113.Ar name
114argument is not specified, the file is split into lexically ordered
115files named with prefixes in the range of
116.Dq Li x-z
117and with suffixes as above.
118.Sh SEE ALSO
119.Xr re_format 7
120.Sh STANDARDS
121The
122.Nm
123utility conforms to
124.St -p1003.1-2001 .
125.Sh HISTORY
126A
127.Nm
128command appeared in
129.At v3 .
130.Sh BUGS
131For historical reasons, if you specify
132.Ar name ,
133.Nm
134can only create 676 separate
135files.
136The default naming convention allows 2028 separate files.
137The
138.Fl a
139option can be used to work around this limitation.
140.Pp
141The maximum line length for matching patterns is 65536.
142