usr.bin/split/split.1

   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.4 2005/08/30 21:25:35 liamfoy 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
  50 The
  51 .Nm
  52 utility reads the given
  53 .Ar file
  54 and breaks it up into files of 1000 lines each.
  55 If
  56 .Ar file
  57 is a single dash
  58 .Pq Sq Fl
  59 or absent,
  60 .Nm
  61 reads from the standard input.
  62 .Pp
  63 The options are as follows:
  64 .Bl -tag -width Ds
  65 .It Fl a Ar suffix_length
  66 Use
  67 .Ar suffix_length
  68 letters to form the suffix of the file name.
  69 .It Fl b Ar byte_count[k|m]
  70 Create smaller files
  71 .Ar byte_count
  72 bytes in length.
  73 If
  74 .Dq Li k
  75 is appended to the number, the file is split into
  76 .Ar byte_count
  77 kilobyte pieces.
  78 If
  79 .Dq Li m
  80 is appended to the number, the file is split into
  81 .Ar byte_count
  82 megabyte pieces.
  83 .It Fl l Ar line_count
  84 Create smaller files
  85 .Ar n
  86 lines in length.
  87 .It Fl p Ar pattern
  88 The file is split whenever an input line matches
  89 .Ar pattern ,
  90 which is interpreted as an extended regular expression.
  91 The matching line will be the first line of the next output file.
  92 This option is incompatible with the
  93 .Fl b
  94 and
  95 .Fl l
  96 options.
  97 .El
  98 .Pp
  99 If additional arguments are specified, the first is used as the name
 100 of the input file which is to be split.
 101 If a second additional argument is specified, it is used as a prefix
 102 for the names of the files into which the file is split.
 103 In this case, each file into which the file is split is named by the
 104 prefix followed by a lexically ordered suffix using
 105 .Ar suffix_length
 106 characters in the range
 107 .Dq Li a-z .
 108 If
 109 .Fl a
 110 is not specified, two letters are used as the suffix.
 111 .Pp
 112 If the
 113 .Ar name
 114 argument is not specified, the file is split into lexically ordered
 115 files named with prefix
 116 .Dq Li x
 117 and with suffixes as above.
 118 .Sh SEE ALSO
 119 .Xr re_format 7
 120 .Sh STANDARDS
 121 The
 122 .Nm
 123 utility conforms to
 124 .St -p1003.1-2001 .
 125 .Sh HISTORY
 126 A
 127 .Nm
 128 command appeared in
 129 .At v3 .
 130 .Sh BUGS
 131 The maximum line length for matching patterns is 65536.