draft/man2/quotactl.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright (C) 1996 Andries Brouwer (aeb@cwi.nl)
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" FIXME There is much that is missing and/or out of date in this page.
  26 .\" (There is a quotactl.2 page in the quotactl package that seems to
  27 .\" have more info than this page.)
  28 .\" As things stand the page more or less documents Linux 2.2 reality:
  29 .\"
  30 .\" Linux 2.2 has:
  31 .\"
  32 .\"     Q_GETQUOTA
  33 .\"     Q_GETSTATS
  34 .\"     Q_QUOTAOFF
  35 .\"     Q_QUOTAON
  36 .\"     Q_RSQUASH (not currently documented)
  37 .\"     Q_SETQLIM
  38 .\"     Q_SETQUOTA
  39 .\"     Q_SETUSE
  40 .\"     Q_SYNC
  41 .\"
  42 .\" Linux 2.4 has:
  43 .\"
  44 .\"     Q_COMP_QUOTAOFF
  45 .\"     Q_COMP_QUOTAON
  46 .\"     Q_COMP_SYNC
  47 .\"     Q_GETFMT
  48 .\"     Q_GETINFO
  49 .\"     Q_GETQUOTA
  50 .\"     Q_QUOTAOFF
  51 .\"     Q_QUOTAON
  52 .\"     Q_SETINFO
  53 .\"     Q_SETQUOTA
  54 .\"     Q_SYNC
  55 .\"     Q_V1_GETQUOTA Q_V1_GETSTATS Q_V1_RSQUASH Q_V1_SETQLIM
  56 .\"     Q_V1_SETQUOTA Q_V1_SETUSE
  57 .\"     Q_V2_GETINFO Q_V2_GETQUOTA Q_V2_SETFLAGS Q_V2_SETGRACE
  58 .\"     Q_V2_SETINFO Q_V2_SETQUOTA Q_V2_SETUSE
  59 .\"     Q_XGETQSTAT Q_XGETQUOTA Q_XQUOTAOFF Q_XQUOTAON Q_XQUOTARM
  60 .\"     Q_XSETQLIM
  61 .\"
  62 .\" Linux 2.6.16 has:
  63 .\"
  64 .\"     Q_GETFMT
  65 .\"     Q_GETINFO
  66 .\"     Q_GETQUOTA
  67 .\"     Q_QUOTAOFF
  68 .\"     Q_QUOTAON
  69 .\"     Q_SETINFO
  70 .\"     Q_SETQUOTA
  71 .\"     Q_SYNC
  72 .\"     Q_XGETQSTAT
  73 .\"     Q_XGETQUOTA
  74 .\"     Q_XQUOTAOFF
  75 .\"     Q_XQUOTAON
  76 .\"     Q_XQUOTARM
  77 .\"     Q_XQUOTASYNC
  78 .\"     Q_XSETQLIM
  79 .\"
  80 .\" Japanese Version Copyright (c) 1997 Kazuyoshi Furutaka
  81 .\"         all rights reserved.
  82 .\" Translated Sun Dec 21 21:58:06 JST 1997
  83 .\"         by Kazuyoshi Furutaka <furutaka@jb3.so-net.or.jp>
  84 .\" Modified Wed Dec 24 22:17:00 JST 1997
  85 .\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  86 .\" Updated & Modified Thu Feb 24 02:50:48 JST 2005
  87 .\"         by Yuichi SATO <ysato444@yahoo.co.jp>
  88 .\"
  89 .TH QUOTACTL 2 2007-06-01 "Linux" "Linux Programmer's Manual"
  90 .\"O .SH NAME
  91 .SH 名前
  92 .\"O quotactl \- manipulate disk quota
  93 quotactl \- ディスク quota を操作する
  94 .\"O .SH SYNOPSIS
  95 .SH 書式
  96 .nf
  97 .B #include <sys/types.h>
  98 .br
  99 .B #include <sys/quota.h>
 100 .sp
 101 .BI "int quotactl(int " cmd ", const char *" special ", int " id \
 102 ", caddr_t " addr );
 103 .fi
 104 .\"O .SH DESCRIPTION
 105 .SH 説明
 106 .\"O The quota system defines for each user and/or group a soft limit
 107 .\"O and a hard limit bounding the amount of disk space that can be
 108 .\"O used on a given file system.
 109 .\"O The hard limit cannot be crossed.
 110 .\"O The soft limit can be crossed, but warnings will ensue.
 111 .\"O Moreover,
 112 .\"O the user cannot be above the soft limit for more than one week (by default)
 113 .\"O at a time: after this week the soft limit counts as hard limit.
 114 quota システムは、各々のユーザ及び/またはグループに対して、
 115 ソフト・リミット及びハード・リミットを定める。これはあるファイル・システムで
 116 使用する事が出来るディスク容量を制限する。
 117 ハード・リミットは超過することは出来ない。
 118 ソフト・リミットは超過する事が出来るが、警告が発せられる。
 119 更に、(デフォルトでは) 一週間以上ソフト・リミットを超過したままに
 120 しておく事はできない: 一週間経過した後はハード・リミットを超過したと
 121 みなされる。
 122
 123 .\"O The
 124 .\"O .BR quotactl ()
 125 .\"O system call manipulates these quota.
 126 .\"O Its first argument is
 127 .\"O of the form
 128 .\"O .BI QCMD( subcmd , type )
 129 .\"O where
 130 .\"O .I type
 131 .\"O is either
 132 .\"O .B USRQUOTA
 133 .\"O or
 134 .\"O .B GRPQUOTA
 135 .\"O (for user quota and group quota, respectively), and
 136 .\"O .I subcmd
 137 .\"O is described below.
 138 .BR quotactl ()
 139 システムコールはこれらの quota に対する操作を行なう。
 140 最初の引き数は
 141 .BI QCMD( subcmd , type )
 142 という形式である。
 143 .I type
 144 には、ユーザー quota については
 145 .B USRQUOTA
 146 を、グループ quota については
 147 .B GRPQUOTA
 148 を指定する。
 149 .I subcmd
 150 は以下で説明する。
 151
 152 .\"O The second argument
 153 .\"O .I special
 154 .\"O is the block special device these quota apply to.
 155 .\"O It must be mounted.
 156 二番目の引き数
 157 .I special
 158 は quota を適用するデバイスのブロック・スペシャル・ファイルである。
 159 そのデバイスはマウントされていなくてはならない。
 160
 161 .\"O The third argument
 162 .\"O .I id
 163 .\"O is the user or group ID these quota apply to (when relevant).
 164 三番目の引き数
 165 .I id
 166 には、(必要な場合に) quota を適用するユーザーもしくはグループの ID を指定する。
 167
 168 .\"O The fourth argument
 169 .\"O .I addr
 170 .\"O is the address of a data structure, depending on the command.
 171 四番目の引き数
 172 .I addr
 173 には、コマンドごとに異ったデータ構造体のアドレスを指定する。
 174
 175 .\"O The
 176 .\"O .I subcmd
 177 .\"O is one of
 178 .I subcmd
 179 は以下のいずれかである
 180 .TP 1.1i
 181 .B Q_QUOTAON
 182 .\"O Enable quota.
 183 .\"O The
 184 .\"O .I addr
 185 .\"O argument is the pathname of the file containing
 186 .\"O the quota for the file system.
 187 quota を有効にする。
 188 .I addr
 189 引き数には、そのファイル・システムの quota が記録されているファイルの
 190 パス名を指定する。
 191 .TP
 192 .B Q_QUOTAOFF
 193 .\"O Disable quota.
 194 quota を無効にする。
 195 .TP
 196 .B Q_GETQUOTA
 197 .\"O Get limits and current usage of disk space.
 198 .\"O The
 199 .\"O .I addr
 200 .\"O argument is a pointer to a dqblk structure (defined in
 201 .\"O .IR <sys/quota.h> ).
 202 ディスク使用量の制限値と現在の使用量を得る。
 203 .I addr
 204 引き数は
 205 .RI ( <sys/quota.h>
 206 で定義された) dqblk 構造体を指すポインタである。
 207 .TP
 208 .B Q_SETQUOTA
 209 .\"O Set limits and current usage;
 210 .\"O .I addr
 211 .\"O is as before.
 212 制限値と現在の使用量を設定する:
 213 .I addr
 214 は同上。
 215 .TP
 216 .B Q_SETQLIM
 217 .\"O Set limits;
 218 .\"O .I addr
 219 .\"O is as before.
 220 制限値を設定する;
 221 .I addr
 222 は同上。
 223 .TP
 224 .B Q_SETUSE
 225 .\"O Set usage.
 226 使用量を設定する。
 227 .TP
 228 .B Q_SYNC
 229 .\"O Sync disk copy of a file system's quota.
 230 ファイル・システムの quota ファイルをディスクと同期させる。
 231 .TP
 232 .B Q_GETSTATS
 233 .\"O Get collected stats.
 234 収集された統計を取得する。
 235 .\"O .SH "RETURN VALUE"
 236 .SH 返り値
 237 .\"O On success,
 238 .\"O .BR quotactl ()
 239 .\"O returns 0.
 240 .\"O On error, \-1 is returned, and
 241 .\"O .I errno
 242 .\"O is set appropriately.
 243 .BR quotactl ()
 244 は、成功時には 0 を返す。エラー時は、\-1 を返すとともに、
 245 .I errno
 246 が適切な値に設定される。
 247 .\"O .SH ERRORS
 248 .SH エラー
 249 .TP 0.9i
 250 .B EACCES
 251 .\"O The quota file is not an ordinary file.
 252 quota ファイルが普通のファイルではない。
 253 .TP
 254 .B EBUSY
 255 .\"O .B Q_QUOTAON
 256 .\"O was asked, but quotas were enabled already.
 257 .B Q_QUOTAON
 258 の要求がなされたが、quota(s) は既に有効になっている。
 259 .TP
 260 .B EFAULT
 261 .\"O Bad
 262 .\"O .I addr
 263 .\"O value.
 264 .I addr
 265 の値に誤りがある。
 266 .TP
 267 .B EINVAL
 268 .\"O .I type
 269 .\"O is not a known quota type.
 270 .\"O Or,
 271 .\"O .I special
 272 .\"O could not be found.
 273 .I type
 274 が既知の quota の形式ではない。もしくは、
 275 .I special
 276 デバイスが見付からなかった。
 277 .TP
 278 .B EIO
 279 .\"O Cannot read or write the quota file.
 280 quota ファイルへの読み書きが出来ない。
 281 .TP
 282 .B EMFILE
 283 .\"O Too many open files: cannot open quota file.
 284 ファイルをオープンしすぎている: quota ファイルをオープン出来ない。
 285 .TP
 286 .B ENODEV
 287 .\"O .I special
 288 .\"O cannot be found in the mount table.
 289 .I special
 290 がマウント・テーブル内に見当たらない。
 291 .TP
 292 .B ENOPKG
 293 .\"O The kernel was compiled without quota support.
 294 quota を使用可にしてカーネルをコンパイルしていない。
 295 .TP
 296 .B ENOTBLK
 297 .\"O .I special
 298 .\"O is not a block special device.
 299 .I special
 300 がブロック・スペシャル・デバイスではない。
 301 .TP
 302 .B EPERM
 303 .\"O The process was not root (for the file system), and
 304 .\"O .B Q_GETQUOTA
 305 .\"O was asked for another
 306 .\"O .I id
 307 .\"O than that of the process itself, or anything other than
 308 .\"O .B Q_GETSTATS
 309 .\"O or
 310 .\"O .B Q_SYNC
 311 .\"O was asked.
 312 プロセスが (そのファイル・システムの) root のものではなく、
 313 かつプロセス自身のものとは異なる
 314 .I id
 315 に対して
 316 .B Q_GETQUOTA
 317 要求を行なった。
 318 もしくは、
 319 .BR Q_GETSTATS ,
 320 .B Q_SYNC
 321 以外の要求がなされた。
 322 .TP
 323 .B ESRCH
 324 .\"O .B Q_GETQUOTA
 325 .\"O or
 326 .\"O .B Q_SETQUOTA
 327 .\"O or
 328 .\"O .B Q_SETUSE
 329 .\"O or
 330 .\"O .B Q_SETQLIM
 331 .\"O was asked for a file system that didn't have quota enabled.
 332 quota が有効になっていないファイル・システムに対して
 333 .BR Q_GETQUOTA ,
 334 .BR Q_SETQUOTA ,
 335 .BR Q_SETUSE ,
 336 .B Q_SETQLIM
 337 のいずれかの要求がなされた。
 338 .\"O .SH "CONFORMING TO"
 339 .SH 準拠
 340 BSD.
 341 .\"O .SH "SEE ALSO"
 342 .SH 関連項目
 343 .BR quota (1),
 344 .BR getrlimit (2),
 345 .BR setrlimit (2),
 346 .BR ulimit (3),
 347 .BR quotacheck (8),
 348 .BR quotaon (8)