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