xref: /minix3/external/bsd/kyua-cli/dist/doc/kyua-about.1.in (revision 11be35a165022172ed3cea20f2b5df0307540b0e)
1*11be35a1SLionel Sambuc.\" Copyright 2012 Google Inc.
2*11be35a1SLionel Sambuc.\" All rights reserved.
3*11be35a1SLionel Sambuc.\"
4*11be35a1SLionel Sambuc.\" Redistribution and use in source and binary forms, with or without
5*11be35a1SLionel Sambuc.\" modification, are permitted provided that the following conditions are
6*11be35a1SLionel Sambuc.\" met:
7*11be35a1SLionel Sambuc.\"
8*11be35a1SLionel Sambuc.\" * Redistributions of source code must retain the above copyright
9*11be35a1SLionel Sambuc.\"   notice, this list of conditions and the following disclaimer.
10*11be35a1SLionel Sambuc.\" * Redistributions in binary form must reproduce the above copyright
11*11be35a1SLionel Sambuc.\"   notice, this list of conditions and the following disclaimer in the
12*11be35a1SLionel Sambuc.\"   documentation and/or other materials provided with the distribution.
13*11be35a1SLionel Sambuc.\" * Neither the name of Google Inc. nor the names of its contributors
14*11be35a1SLionel Sambuc.\"   may be used to endorse or promote products derived from this software
15*11be35a1SLionel Sambuc.\"   without specific prior written permission.
16*11be35a1SLionel Sambuc.\"
17*11be35a1SLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18*11be35a1SLionel Sambuc.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19*11be35a1SLionel Sambuc.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20*11be35a1SLionel Sambuc.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21*11be35a1SLionel Sambuc.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22*11be35a1SLionel Sambuc.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23*11be35a1SLionel Sambuc.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24*11be35a1SLionel Sambuc.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25*11be35a1SLionel Sambuc.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26*11be35a1SLionel Sambuc.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27*11be35a1SLionel Sambuc.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*11be35a1SLionel Sambuc.Dd September 9, 2012
29*11be35a1SLionel Sambuc.Dt KYUA-ABOUT 1
30*11be35a1SLionel Sambuc.Os
31*11be35a1SLionel Sambuc.Sh NAME
32*11be35a1SLionel Sambuc.Nm about
33*11be35a1SLionel Sambuc.Nd Shows general program information
34*11be35a1SLionel Sambuc.Sh SYNOPSIS
35*11be35a1SLionel Sambuc.Nm
36*11be35a1SLionel Sambuc.Op Ar authors | license | version
37*11be35a1SLionel Sambuc.Sh DESCRIPTION
38*11be35a1SLionel SambucThe
39*11be35a1SLionel Sambuc.Sq about
40*11be35a1SLionel Sambuccommand provides generic information about the
41*11be35a1SLionel Sambuc.Xr kyua 1
42*11be35a1SLionel Sambuctool.
43*11be35a1SLionel SambucIn the default synopsis form (no arguments), the information printed
44*11be35a1SLionel Sambucincludes:
45*11be35a1SLionel Sambuc.Bl -enum
46*11be35a1SLionel Sambuc.It
47*11be35a1SLionel SambucThe name of the package, which is
48*11be35a1SLionel Sambuc.Sq __PACKAGE__ .
49*11be35a1SLionel Sambuc.It
50*11be35a1SLionel SambucThe version number, which is
51*11be35a1SLionel Sambuc.Sq __VERSION__ .
52*11be35a1SLionel Sambuc.It
53*11be35a1SLionel SambucLicense information.
54*11be35a1SLionel Sambuc.It
55*11be35a1SLionel SambucAuthors information.
56*11be35a1SLionel Sambuc.It
57*11be35a1SLionel SambucA link to the project web site.
58*11be35a1SLionel Sambuc.El
59*11be35a1SLionel Sambuc.Pp
60*11be35a1SLionel SambucYou can customize the information printed by this command by specifying
61*11be35a1SLionel Sambucthe desired topic as the single argument to the command.
62*11be35a1SLionel SambucThis can be one of:
63*11be35a1SLionel Sambuc.Bl -tag -width authorsXX
64*11be35a1SLionel Sambuc.It Ar authors
65*11be35a1SLionel SambucDisplays the list of authors and contributors only.
66*11be35a1SLionel Sambuc.It Ar license
67*11be35a1SLionel SambucDisplays the license information and the list of copyrights.
68*11be35a1SLionel Sambuc.It Ar version
69*11be35a1SLionel SambucDisplays the package name and the version number in a format that is
70*11be35a1SLionel Sambuccompatible with the output of GNU tools that support a
71*11be35a1SLionel Sambuc.Fl -version
72*11be35a1SLionel Sambucflag.
73*11be35a1SLionel SambucUse this whenever you have to query the version number of the package.
74*11be35a1SLionel Sambuc.El
75*11be35a1SLionel Sambuc.Sh FILES
76*11be35a1SLionel SambucThe following files are read by the
77*11be35a1SLionel Sambuc.Nm
78*11be35a1SLionel Sambuccommand:
79*11be35a1SLionel Sambuc.Bl -tag -width XX
80*11be35a1SLionel Sambuc.It Pa __DOCDIR__/AUTHORS
81*11be35a1SLionel SambucList of authors and contributors.
82*11be35a1SLionel Sambuc.It Pa __DOCDIR__/COPYING
83*11be35a1SLionel SambucLicense information.
84*11be35a1SLionel Sambuc.El
85*11be35a1SLionel Sambuc.Sh EXIT STATUS
86*11be35a1SLionel SambucThe
87*11be35a1SLionel Sambuc.Nm
88*11be35a1SLionel Sambuccommand always returns 0.
89*11be35a1SLionel Sambuc.Pp
90*11be35a1SLionel SambucAdditional exit codes may be returned as described in
91*11be35a1SLionel Sambuc.Xr kyua 1 .
92*11be35a1SLionel Sambuc.Sh SEE ALSO
93*11be35a1SLionel Sambuc.Xr kyua 1
94