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 November 24, 2017 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 stdio.h 40.In sysdecode.h 41.Ft bool 42.Fn sysdecode_quotactl_cmd "FILE *fp" "int cmd" 43.Sh DESCRIPTION 44The 45.Fn sysdecode_quotactl_cmd 46function outputs a text description of the 47.Fa cmd 48argument to 49.Xr quotactl 2 50to the stream 51.Fa fp . 52The description is formatted as an invocation of the 53.Dv QCMD 54macro defined in the 55.In ufs/ufs/quota.h 56header. 57.Pp 58The function first computes the primary and secondary values used by 59.Dv QCMD 60to construct 61.Fa cmd . 62If the primary command value does not represent a known constant, 63.Fn sysdecode_quotactl_cmd 64does not generate any output and returns 65.Dv false . 66Otherwise, 67.Fn sysdecode_quotactl_cmd 68outputs text depicting an invocation of 69.Dv QCMD 70with the associated constants for the primary and secondary command values 71and returns 72.Dv true . 73If the secondary command values does not represent a known constant, 74its value is output as a hexadecimal integer. 75.Sh RETURN VALUES 76The 77.Nm sysdecode_quotactl_cmd 78function returns 79.Dv true 80if it outputs a description of 81.Fa cmd 82and 83.Dv false 84if it does not. 85.Sh EXAMPLES 86The statement 87.Pp 88.Dl sysdecode_quotatcl_cmd(stdout, QCMD(Q_GETQUOTA, USRQUOTA); 89.Pp 90outputs the text 91.Dq QCMD(Q_GETQUOTA, USRQUOTA) 92to standard output. 93.Sh SEE ALSO 94.Xr sysdecode 3 95