| 1 |
.. cyrusman:: arbitron(8) |
| 2 |
|
| 3 |
.. author: Nic Bernstein (Onlight) |
| 4 |
.. author: Jeroen van Meeuwen (Kolab Systems) |
| 5 |
|
| 6 |
.. _imap-reference-manpages-systemcommands-arbitron: |
| 7 |
|
| 8 |
============ |
| 9 |
**arbitron** |
| 10 |
============ |
| 11 |
|
| 12 |
Report readership statistics for mailboxes on the server. |
| 13 |
|
| 14 |
Synopsis |
| 15 |
======== |
| 16 |
|
| 17 |
.. parsed-literal:: |
| 18 |
|
| 19 |
**arbitron** [ **-C** *config-file* ] [ **-o** ] [ **-u** ] [ **-l** ] [ **-p** *months* ] |
| 20 |
[ **-d** *days* | **-D** *mmddyyyy*\ [\ **:**\ *mmddyyyy*] ] *mailbox*... |
| 21 |
|
| 22 |
Description |
| 23 |
=========== |
| 24 |
|
| 25 |
**arbitron** collects and reports readership statistics for mailboxes |
| 26 |
on the server. It also optionally prunes the mailboxes of ``\Seen`` |
| 27 |
state for dormant users. |
| 28 |
|
| 29 |
**arbitron** produces one line of output per mailbox, reporting the |
| 30 |
mailbox name followed by a space, followed by the number of readers |
| 31 |
(and if **-u** is specified, followed by a colon and a comma-separated |
| 32 |
list of the reader's user IDs), and if **-o** is not specified, another |
| 33 |
space and the number of subscribers (and if **-u** is specified, |
| 34 |
followed by a colon and a comma-separated list of the subscribers |
| 35 |
userids). |
| 36 |
|
| 37 |
.. IMPORTANT:: |
| 38 |
|
| 39 |
This format is subject to change in future versions. |
| 40 |
|
| 41 |
Each "reader" is a distinct authorization identity which has the |
| 42 |
:ref:`imap-admin-access-control-right-s` right to the mailbox and which |
| 43 |
has **SELECT**\ ed the mailbox within either the past **-d** *days* or |
| 44 |
the specified **-D** *date*\ [\ **:**\ *range*\ ]. |
| 45 |
|
| 46 |
Users are not counted as reading their own personal mail‐boxes. Personal |
| 47 |
mailboxes are not reported unless there is at least one reader other |
| 48 |
than the mailboxes owner. |
| 49 |
|
| 50 |
**arbitron** |default-conf-text| |
| 51 |
|
| 52 |
Options |
| 53 |
======= |
| 54 |
|
| 55 |
.. program:: arbitron |
| 56 |
|
| 57 |
.. option:: -C config-file |
| 58 |
|
| 59 |
|cli-dash-c-text| |
| 60 |
|
| 61 |
.. option:: -D mmddyyyy[:mmddyyyy], --date=mmddyyyy[:mmddyyyy] |
| 62 |
|
| 63 |
Count as a reader an authorization identity which has used the |
| 64 |
mailbox within the given date range. |
| 65 |
|
| 66 |
The start date and optionally the end date are specified as 2-digit |
| 67 |
month of the year, 2-digit day of the month, and 4-digit year. |
| 68 |
|
| 69 |
If the end date is not specified, the current system time will be |
| 70 |
used as the end time. |
| 71 |
|
| 72 |
.. NOTE:: |
| 73 |
|
| 74 |
Please note that the date notation is American [\ *mmddyyyy*\ ] |
| 75 |
not [\ *ddmmyyyy*\ ]. |
| 76 |
|
| 77 |
.. option:: -d days, --days=days |
| 78 |
|
| 79 |
Count as a reader an authorization identity which has used the |
| 80 |
mailbox within the past *days* days. |
| 81 |
|
| 82 |
.. option:: -l, --detailed |
| 83 |
|
| 84 |
Enable long reporting (comma delimited table consisting of mbox, |
| 85 |
userid, r/s, start time, end time). |
| 86 |
|
| 87 |
.. option:: -o, --no-subscribers |
| 88 |
|
| 89 |
Report "the old way" -- not including subscribers. |
| 90 |
|
| 91 |
.. option:: -p months, --prune-seen=months |
| 92 |
|
| 93 |
Prune ``\Seen`` state for users who have not used the mailbox within |
| 94 |
the past *months* months. The default is infinity. |
| 95 |
|
| 96 |
.. option:: -u, --include-userids |
| 97 |
|
| 98 |
Include userids of mailbox readers in the report. If the report |
| 99 |
will contain mailbox subscribers (see **--no-subscribers**), also |
| 100 |
include userids of the subscribers. |
| 101 |
|
| 102 |
Examples |
| 103 |
======== |
| 104 |
|
| 105 |
.. parsed-literal:: |
| 106 |
|
| 107 |
**arbitron -l** |
| 108 |
|
| 109 |
.. |
| 110 |
|
| 111 |
Long-format list. |
| 112 |
|
| 113 |
.. only:: html |
| 114 |
|
| 115 |
:: |
| 116 |
|
| 117 |
tech.Commits,john,s,04-28-2015 09:45:35,05-28-2015 09:45:35 |
| 118 |
tech.Commits.archive,mary,s,04-28-2015 09:45:35,05-28-2015 09:45:35 |
| 119 |
tech.Commits.archive,john,s,04-28-2015 09:45:35,05-28-2015 09:45:35 |
| 120 |
tech.Commits.archive,sam,s,04-28-2015 09:45:35,05-28-2015 09:45:35 |
| 121 |
tech.Commits.project-1,john,r,04-28-2015 09:45:35,05-28-2015 09:45:35 |
| 122 |
tech.Commits.project-1,mary,s,04-28-2015 09:45:35,05-28-2015 09:45:35 |
| 123 |
tech.Commits.project-1,john,s,04-28-2015 09:45:35,05-28-2015 09:45:35 |
| 124 |
tech.Commits.project-1,sam,s,04-28-2015 09:45:35,05-28-2015 09:45:35 |
| 125 |
tech.Commits.project-2,mary,s,04-28-2015 09:45:35,05-28-2015 09:45:35 |
| 126 |
tech.Commits.project-2,john,s,04-28-2015 09:45:35,05-28-2015 09:45:35 |
| 127 |
tech.Commits.project-2,sam,s,04-28-2015 09:45:35,05-28-2015 09:45:35 |
| 128 |
tech.Commits.project-3,mary,s,04-28-2015 09:45:35,05-28-2015 09:45:35 |
| 129 |
tech.Commits.project-3,john,s,04-28-2015 09:45:35,05-28-2015 09:45:35 |
| 130 |
tech.Commits.project-3,sam,s,04-28-2015 09:45:35,05-28-2015 09:45:35 |
| 131 |
tech.Commits.project-3,todd,s,04-28-2015 09:45:35,05-28-2015 09:45:35 |
| 132 |
tech.Commits.Other,mary,r,04-28-2015 09:45:20,05-28-2015 09:45:20 |
| 133 |
tech.Commits.Other,john,r,04-28-2015 09:45:20,05-28-2015 09:45:20 |
| 134 |
tech.Commits.Other,mary,s,04-28-2015 09:45:20,05-28-2015 09:45:20 |
| 135 |
tech.Commits.Other,john,s,04-28-2015 09:45:20,05-28-2015 09:45:20 |
| 136 |
tech.Commits.Other,sam,s,04-28-2015 09:45:20,05-28-2015 09:45:20 |
| 137 |
|
| 138 |
.. parsed-literal:: |
| 139 |
|
| 140 |
**arbitron -o** |
| 141 |
|
| 142 |
.. |
| 143 |
|
| 144 |
Old format (no subscribers) short list. |
| 145 |
|
| 146 |
.. only:: html |
| 147 |
|
| 148 |
:: |
| 149 |
|
| 150 |
tech.Commits 0 |
| 151 |
tech.Commits.archive 0 |
| 152 |
tech.Commits.project-1 1 |
| 153 |
tech.Commits.project-1 0 |
| 154 |
tech.Commits.project-1 0 |
| 155 |
tech.Commits.Other 2 |
| 156 |
|
| 157 |
.. parsed-literal:: |
| 158 |
|
| 159 |
**arbitron** |
| 160 |
|
| 161 |
.. |
| 162 |
|
| 163 |
Normal short list. |
| 164 |
|
| 165 |
.. only:: html |
| 166 |
|
| 167 |
:: |
| 168 |
|
| 169 |
tech.Commits 0 2 |
| 170 |
tech.Commits.archive 0 4 |
| 171 |
tech.Commits.project-1 1 4 |
| 172 |
tech.Commits.project-2 0 4 |
| 173 |
tech.Commits.project-3 0 5 |
| 174 |
tech.Commits.Other 2 4 |
| 175 |
|
| 176 |
.. parsed-literal:: |
| 177 |
|
| 178 |
**arbitron -d** *14* |
| 179 |
|
| 180 |
.. |
| 181 |
|
| 182 |
Normal short list format for the past *14* days. |
| 183 |
|
| 184 |
.. only:: html |
| 185 |
|
| 186 |
:: |
| 187 |
|
| 188 |
tech.Commits 0 2 |
| 189 |
tech.Commits.archive 0 4 |
| 190 |
tech.Commits.project-1 1 4 |
| 191 |
tech.Commits.project-2 0 4 |
| 192 |
tech.Commits.project-3 0 5 |
| 193 |
tech.Commits.Other 2 4 |
| 194 |
|
| 195 |
.. parsed-literal:: |
| 196 |
|
| 197 |
**arbitron -D** *04012015*\ :\ *04152015* |
| 198 |
|
| 199 |
.. |
| 200 |
|
| 201 |
Normal short list Within date range of 12 - 15 April, 2015. |
| 202 |
|
| 203 |
.. only:: html |
| 204 |
|
| 205 |
:: |
| 206 |
|
| 207 |
tech.Commits 0 2 |
| 208 |
tech.Commits.archive 0 4 |
| 209 |
tech.Commits.project-1 0 4 |
| 210 |
tech.Commits.project-2 1 4 |
| 211 |
tech.Commits.project-3 0 5 |
| 212 |
tech.Commits.Other 0 4 |
| 213 |
|
| 214 |
Files |
| 215 |
===== |
| 216 |
|
| 217 |
/etc/imapd.conf |
| 218 |
|
| 219 |
See Also |
| 220 |
======== |
| 221 |
|
| 222 |
:cyrusman:`imapd.conf(5)` |