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