xref: /freebsd/lib/libsysdecode/sysdecode_quotactl_cmd.3 (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
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.\" $FreeBSD$
26.\"
27.Dd November 24, 2017
28.Dt sysdecode_quotactl_cmd 3
29.Os
30.Sh NAME
31.Nm sysdecode_quotactl_cmd
32.Nd output name of quotactl command
33.Sh LIBRARY
34.Lb libsysdecode
35.Sh SYNOPSIS
36.In sys/types.h
37.In stdbool.h
38.In stdio.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