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