pure-quotacheck.8.in 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. .TH "pure-quotacheck" "8" "@VERSION@" "Frank Denis" "Pure-FTPd"
  2. .SH "NAME"
  3. .LP
  4. pure\-quotacheck \- Update virtual quota files for Pure\-FTPd
  5. .SH "SYNTAX"
  6. .LP
  7. pure\-quotacheck \fI\-u username/gid\fP \fI\-d home directory\fP [\fI\-g group/gid\fP]
  8. .SH "DESCRIPTION"
  9. .LP
  10. pure\-quotacheck create a \fB.ftpquota\fR file in the specified directory.
  11. .br
  12. This file contains the current file and size of the directory, and it is used by Pure\-FTPd when virtual quotas are enabled.
  13. .br
  14. It's recommended to periodically run pure\-quotacheck for every user, in crontabs.
  15. .SH "OPTIONS"
  16. .TP
  17. \fB\-d\fR <\fIdirectory\fP>
  18. Scans the specified <\fIdirectory\fP>.
  19. .TP
  20. \fB\-g\fR <\fIgroup or gid\fP>
  21. Sets the group files will be scanned as. This is optional: if a user name is passed to \fB\-u</fR>, group are automatically retrieved.
  22. .TP
  23. \fB\-u\fR <\fIuser or uid\fP>
  24. Set the user name files will be scanned as. This is mandatory, and it can't be "root".
  25. .TP
  26. \fB\-h\fR
  27. Output usage information and exit.
  28. .SH "FILES"
  29. .LP
  30. \fI.ftpquota\fP
  31. .SH "EXAMPLES"
  32. .LP
  33. To run this program the standard way type:
  34. .LP
  35. pure\-quotacheck \-u john \-d /home/john
  36. .SH "AUTHORS"
  37. .LP
  38. Frank DENIS <j at pureftpd dot org>
  39. .SH "SECURITY"
  40. pure\-quotacheck switches real and effective uids/gids as soon as possible. Root privileges are never given back.
  41. .br
  42. pure\-quotacheck refuses to scan directories with uid = 0 (root) or gid = 0 (wheel/root) .
  43. .br
  44. pure\-quotacheck performs a chroot() call to the home directory. It never traverses parent directories.
  45. .br
  46. pure\-quotacheck only scans real files (no socket, no pipe, etc) .
  47. .br
  48. pure\-quotacheck enforces read access on directories to prevent against people doing chmod 0 before a quota scan.
  49. .br
  50. pure\-quotacheck enforces write access on the home directory to properly write the .ftpquota file.
  51. .br
  52. pure\-quotacheck never scans the same inode/device pair twice.
  53. .SH "SEE ALSO"
  54. .BR "ftp(1)" ,
  55. .BR "pure-ftpd(8)"
  56. .BR "pure-ftpwho(8)"
  57. .BR "pure-mrtginfo(8)"
  58. .BR "pure-uploadscript(8)"
  59. .BR "pure-statsdecode(8)"
  60. .BR "pure-pw(8)"
  61. .BR "pure-quotacheck(8)"
  62. .BR "pure-authd(8)"
  63. .BR "pure-certd(8)"
  64. .BR "RFC 959",
  65. .BR "RFC 2228",
  66. .BR "RFC 2389" " and"
  67. .BR "RFC 2428" .