xref: /openbsd/usr.bin/csplit/csplit.1 (revision 8529ddd3)
1.\"	$OpenBSD: csplit.1,v 1.11 2014/02/04 13:26:36 jmc Exp $
2.\"
3.\" Copyright (c) 2002 Tim J. Robbins.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" $FreeBSD: src/usr.bin/csplit/csplit.1,v 1.11 2005/01/25 22:29:51 tjr Exp $
28.\"
29.Dd $Mdocdate: February 4 2014 $
30.Dt CSPLIT 1
31.Os
32.Sh NAME
33.Nm csplit
34.Nd split files based on context
35.Sh SYNOPSIS
36.Nm
37.Op Fl ks
38.Op Fl f Ar prefix
39.Op Fl n Ar number
40.Ar file args ...
41.Sh DESCRIPTION
42The
43.Nm
44utility splits
45.Ar file
46into pieces using the patterns
47.Ar args .
48If
49.Ar file
50is
51a dash
52.Pq Sq - ,
53.Nm
54reads from standard input.
55.Pp
56Files are created with a prefix of
57.Dq xx
58and two decimal digits.
59The size of each file is written to standard output
60as it is created.
61If an error occurs whilst files are being created,
62or a
63.Dv HUP ,
64.Dv INT ,
65or
66.Dv TERM
67signal is received,
68all files previously written are removed.
69.Pp
70The options are as follows:
71.Bl -tag -width indent
72.It Fl f Ar prefix
73Create file names beginning with
74.Ar prefix ,
75instead of
76.Dq xx .
77.It Fl k
78Do not remove previously created files if an error occurs or a
79.Dv HUP ,
80.Dv INT ,
81or
82.Dv TERM
83signal is received.
84.It Fl n Ar number
85Create file names beginning with
86.Ar number
87of decimal digits after the prefix,
88instead of 2.
89.It Fl s
90Do not write the size of each output file to standard output as it is
91created.
92.El
93.Pp
94The
95.Ar args
96operands may be a combination of the following patterns:
97.Bl -tag -width indent
98.It Xo
99.Sm off
100.No / Ar regexp No /
101.Op Oo Cm + | - Oc Ar offset
102.Sm on
103.Xc
104Create a file containing the input from the current line to (but not including)
105the next line matching the given basic regular expression.
106An optional
107.Ar offset
108from the line that matched may be specified.
109.It Xo
110.Sm off
111.No % Ar regexp No %
112.Op Oo Cm + | - Oc Ar offset
113.Sm on
114.Xc
115Same as above but a file is not created for the output.
116.It Ar line_no
117Create containing the input from the current line to (but not including)
118the specified line number.
119.It { Ns Ar num Ns }
120Repeat the previous pattern the specified number of times.
121If it follows a line number pattern, a new file will be created for each
122.Ar line_no
123lines,
124.Ar num
125times.
126The first line of the file is line number 1 for historic reasons.
127.El
128.Pp
129After all the patterns have been processed, the remaining input data
130(if there is any) will be written to a new file.
131.Pp
132Requesting to split at a line before the current line number or past the
133end of the file will result in an error.
134.Sh EXIT STATUS
135.Ex -std csplit
136.Sh EXAMPLES
137Split the
138.Xr mdoc 7
139file
140.Pa foo.1
141into one file for each section (up to 21):
142.Pp
143.Dl "$ csplit -k foo.1 '%^\e.Sh%' '/^\e.Sh/' '{20}'"
144.Pp
145Split standard input after the first 99 lines and every 100 lines thereafter:
146.Pp
147.Dl "$ csplit -k - 100 '{19}'"
148.Sh SEE ALSO
149.Xr sed 1 ,
150.Xr split 1 ,
151.Xr re_format 7
152.Sh STANDARDS
153The
154.Nm
155utility is compliant with the
156.St -p1003.1-2008
157specification.
158.Sh HISTORY
159A
160.Nm
161command appeared in PWB
162.Ux .
163.Sh BUGS
164Input lines are limited to
165.Dv LINE_MAX
166(2048) bytes in length.
167