File: arbitron.rst.txt

package info (click to toggle)
cyrus-imapd 3.10.0~beta1-3
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 86,332 kB
  • sloc: ansic: 284,810; perl: 135,824; javascript: 9,562; sh: 5,728; yacc: 2,565; cpp: 2,147; makefile: 2,133; lex: 662; xml: 621; awk: 303; python: 279; asm: 262
file content (222 lines) | stat: -rw-r--r-- 6,003 bytes parent folder | download | duplicates (14)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
.. cyrusman:: arbitron(8)

.. author: Nic Bernstein (Onlight)
.. author: Jeroen van Meeuwen (Kolab Systems)

.. _imap-reference-manpages-systemcommands-arbitron:

============
**arbitron**
============

Report readership statistics for mailboxes on the server.

Synopsis
========

.. parsed-literal::

    **arbitron** [ **-C** *config-file* ] [ **-o** ] [ **-u** ] [ **-l** ] [ **-p** *months* ]
             [ **-d** *days* | **-D** *mmddyyyy*\ [\ **:**\ *mmddyyyy*] ] *mailbox*...

Description
===========

**arbitron** collects and reports readership statistics for mailboxes
on the server. It also optionally prunes the mailboxes of ``\Seen``
state for dormant users.

**arbitron** produces one line of output per mailbox, reporting the
mailbox name followed by a space, followed by the number of readers
(and if **-u** is specified, followed by a colon and a comma-separated
list of the reader's user IDs), and if **-o** is not specified, another
space and the number of subscribers (and if **-u** is specified,
followed by a colon and a comma-separated list of the subscribers
userids).

.. IMPORTANT::

    This format is subject to change in future versions.

Each "reader" is a distinct authorization identity which has the
:ref:`imap-admin-access-control-right-s` right to the mailbox and which
has **SELECT**\ ed the mailbox within either the past **-d** *days* or
the specified **-D** *date*\ [\ **:**\ *range*\ ].

Users are not counted as reading their own personal mail‐boxes. Personal
mailboxes are not reported unless there is at least one reader other
than the mailboxes owner.

**arbitron** |default-conf-text|

Options
=======

.. program:: arbitron

.. option:: -C config-file

    |cli-dash-c-text|

.. option:: -D mmddyyyy[:mmddyyyy], --date=mmddyyyy[:mmddyyyy]

    Count as a reader an authorization identity which has used the
    mailbox within the given date range.

    The start date and optionally the end date are specified as 2-digit
    month of the year, 2-digit day of the month, and 4-digit year.

    If the end date is not specified, the current system time will be
    used as the end time.

    .. NOTE::

        Please note that the date notation is American [\ *mmddyyyy*\ ]
        not [\ *ddmmyyyy*\ ].

.. option:: -d days, --days=days

    Count as a reader an authorization identity which has used the
    mailbox within the past *days* days.

.. option:: -l, --detailed

    Enable long reporting (comma delimited table consisting of mbox,
    userid, r/s, start time, end time).

.. option:: -o, --no-subscribers

    Report "the old way" -- not including subscribers.

.. option:: -p months, --prune-seen=months

    Prune ``\Seen`` state for users who have not used the mailbox within
    the past *months* months. The default is infinity.

.. option:: -u, --include-userids

    Include userids of mailbox readers in the report.  If the report
    will contain mailbox subscribers (see **--no-subscribers**), also
    include userids of the subscribers.

Examples
========

.. parsed-literal::

    **arbitron -l**

..

        Long-format list.

.. only:: html

    ::

        tech.Commits,john,s,04-28-2015 09:45:35,05-28-2015 09:45:35
        tech.Commits.archive,mary,s,04-28-2015 09:45:35,05-28-2015 09:45:35
        tech.Commits.archive,john,s,04-28-2015 09:45:35,05-28-2015 09:45:35
        tech.Commits.archive,sam,s,04-28-2015 09:45:35,05-28-2015 09:45:35
        tech.Commits.project-1,john,r,04-28-2015 09:45:35,05-28-2015 09:45:35
        tech.Commits.project-1,mary,s,04-28-2015 09:45:35,05-28-2015 09:45:35
        tech.Commits.project-1,john,s,04-28-2015 09:45:35,05-28-2015 09:45:35
        tech.Commits.project-1,sam,s,04-28-2015 09:45:35,05-28-2015 09:45:35
        tech.Commits.project-2,mary,s,04-28-2015 09:45:35,05-28-2015 09:45:35
        tech.Commits.project-2,john,s,04-28-2015 09:45:35,05-28-2015 09:45:35
        tech.Commits.project-2,sam,s,04-28-2015 09:45:35,05-28-2015 09:45:35
        tech.Commits.project-3,mary,s,04-28-2015 09:45:35,05-28-2015 09:45:35
        tech.Commits.project-3,john,s,04-28-2015 09:45:35,05-28-2015 09:45:35
        tech.Commits.project-3,sam,s,04-28-2015 09:45:35,05-28-2015 09:45:35
        tech.Commits.project-3,todd,s,04-28-2015 09:45:35,05-28-2015 09:45:35
        tech.Commits.Other,mary,r,04-28-2015 09:45:20,05-28-2015 09:45:20
        tech.Commits.Other,john,r,04-28-2015 09:45:20,05-28-2015 09:45:20
        tech.Commits.Other,mary,s,04-28-2015 09:45:20,05-28-2015 09:45:20
        tech.Commits.Other,john,s,04-28-2015 09:45:20,05-28-2015 09:45:20
        tech.Commits.Other,sam,s,04-28-2015 09:45:20,05-28-2015 09:45:20

.. parsed-literal::

    **arbitron -o**

..

        Old format (no subscribers) short list.

.. only:: html

    ::

        tech.Commits 0
        tech.Commits.archive 0
        tech.Commits.project-1 1
        tech.Commits.project-1 0
        tech.Commits.project-1 0
        tech.Commits.Other 2

.. parsed-literal::

    **arbitron**

..

        Normal short list.

.. only:: html

    ::

        tech.Commits 0 2
        tech.Commits.archive 0 4
        tech.Commits.project-1 1 4
        tech.Commits.project-2 0 4
        tech.Commits.project-3 0 5
        tech.Commits.Other 2 4

.. parsed-literal::

    **arbitron -d** *14*

..

        Normal short list format for the past *14* days.

.. only:: html

    ::

        tech.Commits 0 2
        tech.Commits.archive 0 4
        tech.Commits.project-1 1 4
        tech.Commits.project-2 0 4
        tech.Commits.project-3 0 5
        tech.Commits.Other 2 4

.. parsed-literal::

    **arbitron -D** *04012015*\ :\ *04152015*

..

        Normal short list Within date range of 12 - 15 April, 2015.

.. only:: html

    ::

        tech.Commits 0 2
        tech.Commits.archive 0 4
        tech.Commits.project-1 0 4
        tech.Commits.project-2 1 4
        tech.Commits.project-3 0 5
        tech.Commits.Other 0 4

Files
=====

/etc/imapd.conf

See Also
========

:cyrusman:`imapd.conf(5)`