kopano-set-oof.1 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. '\" t
  2. .\" Title: kopano-set-oof
  3. .\" Author: [see the "Author" section]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
  5. .\" Date: November 2016
  6. .\" Manual: Kopano Core user reference
  7. .\" Source: Kopano 8
  8. .\" Language: English
  9. .\"
  10. .TH "KOPANO\-SET\-OOF" "1" "November 2016" "Kopano 8" "Kopano Core user reference"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. kopano-set-oof \- Control a user\*(Aqs out of office settings\&.
  32. .SH "SYNOPSIS"
  33. .HP \w'\fBkopano\-set\-oof\fR\ 'u
  34. \fBkopano\-set\-oof\fR [\-h\ \fIhostname\fR] [\-m\ \fImode\fR] [\-n\ \fImsgfile\fR] [\-p\ \fIkeypass\fR] [\-s\ \fIkeyfile\fR] [\-t\ \fIsubject\fR] [\-u\ \fIusername\fR] [\-\-from\ \fIdatetime\fR\ \-\-until\ \fIdatetime\fR]
  35. .SH "DESCRIPTION"
  36. .PP
  37. This tool can be used to change a user\*(Aqs out of office settings\&. The storage server must be running for
  38. \fBkopano\-set\-oof\fR
  39. to work\&.
  40. .SH "OPTIONS"
  41. .PP
  42. \fB\-h\fR \fIhostname\fR
  43. .RS 4
  44. Connect to the given storage server\&. This defaults to file:///var/run/kopano/server\&.sock\&.
  45. .RE
  46. .PP
  47. \fB\-m\fR, \fB\-\-mode\fR \fB0\fR
  48. .RS 4
  49. Disable the user\*(Aqs out of office reply\&.
  50. .RE
  51. .PP
  52. \fB\-m\fR, \fB\-\-mode\fR \fB1\fR
  53. .RS 4
  54. Enable the user\*(Aqs out of office reply\&.
  55. .RE
  56. .PP
  57. \fB\-m\fR, \fB\-\-mode\fR \fB\-\fR
  58. .RS 4
  59. Don\*(Aqt enable or disable the user\*(Aqs out of office reply\&. Just update the subject and message, unless the user\*(Aqs out of office reply is enabled\&. This is the default mode\&.
  60. .sp
  61. This is useful to update all out of office settings without enabling them and without changing the messages of enabled replies because that might overwrite some useful information that a user has set\&.
  62. .RE
  63. .PP
  64. \fB\-n\fR, \fB\-\-message\fR \fIfile\fR
  65. .RS 4
  66. Reads the given text file and uses its contents for the autoreply\*(Aqs message body\&.
  67. .RE
  68. .PP
  69. \fB\-p\fR, \fB\-\-sslkey\-pass\fR \fIpassword\fR
  70. .RS 4
  71. Use the given password to access the certificate\&.
  72. .RE
  73. .PP
  74. \fB\-s\fR, \fB\-\-sslkey\-file\fR \fIsslkey\fR
  75. .RS 4
  76. Use the given certificate when connecting to the storage server\&.
  77. .RE
  78. .PP
  79. \fB\-t\fR, \fB\-\-subject\fR \fItext\fR
  80. .RS 4
  81. The subject for Out Of Office messages will be set to the specified text\&.
  82. .RE
  83. .PP
  84. \fB\-u\fR, \fB\-\-user\fR \fIname\fR
  85. .RS 4
  86. Modify the Out Of Office settings for the particular user\&.
  87. .RE
  88. .PP
  89. \fB\-\-from\fR, \fB\-\-until\fR \fIdatetime\fR
  90. .RS 4
  91. Limit the OOF responder to the given timeframe\&. Both options, or neither of the two, must be specified\&. The format to use as argument is to be in the form of "2015\-04\-01 23:50" (ISO\-8601\-like), and is taken to be in local time\&.
  92. .RE
  93. .SH "AUTHOR"
  94. .PP
  95. Written by Kopano\&.