1.\"
2.\" Copyright (c) 2016 John Baldwin <jhb@FreeBSD.org>
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd November 24, 2017
26.Dt sysdecode_quotactl_cmd 3
27.Os
28.Sh NAME
29.Nm sysdecode_quotactl_cmd
30.Nd output name of quotactl command
31.Sh LIBRARY
32.Lb libsysdecode
33.Sh SYNOPSIS
34.In sysdecode.h
35.Ft bool
36.Fn sysdecode_quotactl_cmd "FILE *fp" "int cmd"
37.Sh DESCRIPTION
38The
39.Fn sysdecode_quotactl_cmd
40function outputs a text description of the
41.Fa cmd
42argument to
43.Xr quotactl 2
44to the stream
45.Fa fp .
46The description is formatted as an invocation of the
47.Dv QCMD
48macro defined in the
49.In ufs/ufs/quota.h
50header.
51.Pp
52The function first computes the primary and secondary values used by
53.Dv QCMD
54to construct
55.Fa cmd .
56If the primary command value does not represent a known constant,
57.Fn sysdecode_quotactl_cmd
58does not generate any output and returns
59.Dv false .
60Otherwise,
61.Fn sysdecode_quotactl_cmd
62outputs text depicting an invocation of
63.Dv QCMD
64with the associated constants for the primary and secondary command values
65and returns
66.Dv true .
67If the secondary command values does not represent a known constant,
68its value is output as a hexadecimal integer.
69.Sh RETURN VALUES
70The
71.Nm sysdecode_quotactl_cmd
72function returns
73.Dv true
74if it outputs a description of
75.Fa cmd
76and
77.Dv false
78if it does not.
79.Sh EXAMPLES
80The statement
81.Pp
82.Dl sysdecode_quotatcl_cmd(stdout, QCMD(Q_GETQUOTA, USRQUOTA);
83.Pp
84outputs the text
85.Dq QCMD(Q_GETQUOTA, USRQUOTA)
86to standard output.
87.Sh SEE ALSO
88.Xr sysdecode 3
89