pure-ftpwho.8.in 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. .TH "pure-ftpwho" "8" "@VERSION@" "Frank Denis" "Pure-FTPd"
  2. .SH "NAME"
  3. .LP
  4. pure\-ftpwho \- Report current FTP sessions
  5. .SH "SYNTAX"
  6. .LP
  7. pure\-ftpwho [\fI\-c\fP] [\fI\-h\fP] [\fI\-H\fP] [\fI\-n\fP] [\fI\-p\fP] [\fI\-s\fP] [\fI\-v\fP] [\fI\-w\fP] [\fI\-W\fP] [\fI\-x\fP]
  8. .SH "DESCRIPTION"
  9. .LP
  10. pure\-ftpwho shows current Pure\-FTPd client sessions.
  11. Only the system administrator may run this.
  12. Output can be text (default), HTML, XML data and parser-optimized.
  13. The server has to be compiled with
  14. .B \-\-with\-ftpwho
  15. to support this command.
  16. .SH "OPTIONS"
  17. .TP
  18. \fB\-c\fR
  19. the program is called via a web server (CGI interface) . Output is a
  20. full HTML page with the initial content\-type header. This option is
  21. automatically enabled if an environment variable called GATEWAY_INTERFACE is
  22. found. This is the default if you can the program from a CGI\-enabled web
  23. server.
  24. .TP
  25. \fB\-h\fR
  26. Output help information and exit.
  27. .TP
  28. \fB\-H\fR
  29. Don't resolve host names, and only show IP addresses (faster).
  30. .TP
  31. \fB\-n\fR
  32. A synonym for \-H.
  33. .TP
  34. \fB\-p\fR
  35. Output Mac OSX / GNUStep plist data.
  36. .TP
  37. \fB\-s\fR
  38. Output only one line per client, with only numeric data, delimited by a | character.
  39. It's not very human-readable, but it's designed for easy parsing by shell scripts (cut/sed) .
  40. \&'|' characters in user names or file names are quoted (\e|) .
  41. .TP
  42. \fB\-v\fR
  43. Output an ASCII table (just like the default mode), with more info.
  44. The verbose output includes the local IP, the local port, the total size of
  45. transferred files and the current number of transferred bytes.
  46. .TP
  47. \fB\-w\fR
  48. Output a complete HTML page (web mode).
  49. .TP
  50. \fB\-W\fR
  51. Output an HTML page with no header and no footer. This is an embedded
  52. mode, suitable for inline calls from CGI, SSI or PHP scripts.
  53. .TP
  54. \fB\-x\fR
  55. Output well\-formed XML data for post\-processing.
  56. .SH "FILES"
  57. .LP
  58. \fB@LOCALSTATEDIR@/run/pure-ftpd/\fP
  59. Scoreboard directory. Should always owned by root and on a lockable
  60. filesystem.
  61. .SH "ENVIRONMENT VARIABLES"
  62. .TP
  63. \fBGATEWAY_INTERFACE\fP
  64. If found, automatically run in CGI mode and output HTML data.
  65. .SH "AUTHORS"
  66. .LP
  67. Frank DENIS <j at pureftpd dot org>
  68. .SH "SEE ALSO"
  69. .BR "ftp(1)" ,
  70. .BR "pure-ftpd(8)"
  71. .BR "pure-ftpwho(8)"
  72. .BR "pure-mrtginfo(8)"
  73. .BR "pure-uploadscript(8)"
  74. .BR "pure-statsdecode(8)"
  75. .BR "pure-pw(8)"
  76. .BR "pure-quotacheck(8)"
  77. .BR "pure-authd(8)"
  78. .BR "pure-certd(8)"
  79. .BR "RFC 959" ,
  80. .BR "RFC 2389",
  81. .BR "RFC 2228" " and"
  82. .BR "RFC 2428" .