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