xref: /dragonfly/usr.bin/split/split.1 (revision 2b7dbe20)
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. 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: src/usr.bin/split/split.1,v 1.3.2.6 2003/04/21 21:16:25 andreas Exp $
30.\"
31.Dd May 25, 2013
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.Fl d
40.Op Fl a Ar suffix_length
41.Op Fl b Ar byte_count[suffix]
42.Op Fl l Ar line_count
43.Op Fl p Ar pattern
44.Op Ar file Op Ar name
45.Sh DESCRIPTION
46The
47.Nm
48utility reads the given
49.Ar file
50and breaks it up into files of 1000 lines each.
51If
52.Ar file
53is a single dash
54.Pq Sq Fl
55or absent,
56.Nm
57reads from the standard input.
58.Pp
59The options are as follows:
60.Bl -tag -width Ds
61.It Fl a Ar suffix_length
62Use
63.Ar suffix_length
64letters to form the suffix of the file name.
65.It Fl b Ar byte_count[suffix]
66Create smaller files
67.Ar byte_count
68bytes in length.
69An optional suffix (as documented in
70.Xr dehumanize_number 3 )
71is supported.
72.It Fl d
73Use a numeric suffix instead of an alphabetic suffix.
74.It Fl l Ar line_count
75Create smaller files
76.Ar n
77lines in length.
78.It Fl p Ar pattern
79The file is split whenever an input line matches
80.Ar pattern ,
81which is interpreted as an extended regular expression.
82The matching line will be the first line of the next output file.
83This option is incompatible with the
84.Fl b
85and
86.Fl l
87options.
88.El
89.Pp
90If additional arguments are specified, the first is used as the name
91of the input file which is to be split.
92If a second additional argument is specified, it is used as a prefix
93for the names of the files into which the file is split.
94In this case, each file into which the file is split is named by the
95prefix followed by a lexically ordered suffix using
96.Ar suffix_length
97characters in the range
98.Dq Li a-z .
99If
100.Fl a
101is not specified, two letters are used as the suffix.
102.Pp
103If the
104.Ar name
105argument is not specified, the file is split into lexically ordered
106files named with prefix
107.Dq Li x
108and with suffixes as above.
109.Sh SEE ALSO
110.Xr re_format 7
111.Sh STANDARDS
112The
113.Nm
114utility conforms to
115.St -p1003.1-2001 .
116.Sh HISTORY
117A
118.Nm
119command appeared in
120.At v3 .
121.Sh BUGS
122The maximum line length for matching patterns is 65536.
123