external/bsd/atf/dist/tools/atf-format.1

   1 .\"
   2 .\" Automated Testing Framework (atf)
   3 .\"
   4 .\" Copyright (c) 2007, 2008 The NetBSD Foundation, Inc.
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
  17 .\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  18 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
  21 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  23 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  26 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  27 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .Dd August 18, 2007
  30 .Dt ATF-FORMAT 1
  31 .Os
  32 .Sh NAME
  33 .Nm atf-format
  34 .Nd formats a text paragraph to fit nicely on screen
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Ar str1 Op Ar .. strN
  38 .Nm
  39 .Fl t Ar tag
  40 .Op Fl l Ar length
  41 .Op Fl r
  42 .Op Ar str1 Op Ar .. strN
  43 .Nm
  44 .Fl h
  45 .Sh DESCRIPTION
  46 .Nm
  47 formats text messages to not overflow the terminal's width, and optionally
  48 adds a prefix string to them.
  49 Messages can be fed through the standard input or through multiple
  50 arguments; in the latter case, all of them are concatenated as if they were
  51 separated by a single space.
  52 Different lines (those separated by a new-line character) are treated as
  53 different paragraphs and thus formatted accordingly.
  54 .Pp
  55 In the first synopsis form,
  56 .Nm
  57 formats the message to not overflow the terminal's width.
  58 The message is supposed to start at column 0.
  59 .Pp
  60 In the second synopsis form,
  61 .Nm
  62 also formats the message to not overflow the terminal's width, but it
  63 appends a tag to the beginning of the string.
  64 This tag may or may be not repeated on each line of the text; if it is
  65 not repeated, the text is simply indented.
  66 This synopsis form is useful to easily format two-column tables, being the
  67 first one much shorter than the second one.
  68 The message is supposed to start at column 0.
  69 .Pp
  70 In the third synopsis form,
  71 .Nm
  72 will print information about all supported options and their purpose.
  73 .Pp
  74 The following options are available:
  75 .Bl -tag -width XlXlengthXX
  76 .It Fl h
  77 Shows a short summary of all available options and their purpose.
  78 .It Fl l Ar length
  79 Specifies the length in characters of te tag.
  80 Useful if the tag is shorter than the desired length, which happens when
  81 formatting two-column tables.
  82 .It Fl r
  83 Repeat the tag on each line.
  84 Otherwise it is only shown on the first one, and all others are indented
  85 appropriately using whitespace.
  86 .It Fl t Ar tag
  87 Specifies the tag to use
  88 .El
  89 .Sh SEE ALSO
  90 .Xr atf 7