tabular.1

   1 .\" SPDX-License-Identifier: BSD-2-Clause
   2
   3 .\" Copyright (c) 2021 Alessio Chiapperini
   4
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25
  26 .Dd October 9, 2021
  27 .Dt TABULAR 1
  28 .Os
  29 .Sh NAME
  30 .Nm tabular
  31 .Nd pretty prints tabular data
  32 .Sh SYNOPSIS
  33 .Nm
  34 .Op Fl s Ar sep
  35 .Op Ar
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 utility reads files containing tabular data sequentially and pretty prints them as a table.
  40 The
  41 .Ar file
  42 operands are processed in command-line order. If the
  43 .Ar file
  44 is a single dash
  45 .Pq Sq Fl ,
  46 or absent,
  47 .Nm
  48 reads from standard input. The separator character of each column in the dataset can be specified at
  49 run-time, which defaults to the comma character.
  50 .Pp
  51 The options are as follows:
  52 .Bl -tag -width indent
  53 .It Fl s Ar sep
  54 Use
  55 .Ar sep
  56 as the field delimiter character instead of the comma character.
  57 .El
  58 .Sh "EXIT STATUS"
  59 The
  60 .Nm
  61 utility exits 0 on success, and 1 if an error occurs.
  62 .Sh EXAMPLES
  63 Pretty print the text received from stdin where each field is separated by the comma character:
  64 .Dl "tabular"
  65 .Pp
  66 Pretty print file passed as parameter:
  67 .Pp
  68 .Dl "tabular addresses.csv"
  69 .Pp
  70 Pretty print files passed as parameters where the content of the second file is taken from stdin:
  71 .Pp
  72 .Dl "tabular tally_cab.csv - addresses.csv"
  73 .Pp
  74 Pipe the out of cat to tabular where the field separator is set to the semicolon character:
  75 .Dl "cat names.csv | tabular -s ';'"
  76 .Sh SEE ALSO
  77 .Xr column 1
  78 .Sh BUGS
  79 .Bl -tag -width indent
  80 .It Input lines are limited to LINE_MAX bytes in length.
  81 .It Only single character separators are allowed.
  82 .It The program presumes the locale is UTF-8.
  83 .El
  84 .Sh AUTHOR
  85 .An Alessio Chiapperini Aq Mt alessio.chiapperini@\:nullbuffer.com
  86