lib/libsysdecode/sysdecode_quotactl_cmd.3

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