mlmmj-rbarchiver 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 80d034232b497d80a43d982c82f4ac823a110782
4
- data.tar.gz: 4f2160f2d0f7d0dbf03b25e7580244980fa86d60
3
+ metadata.gz: 903fd842be763a7bd56d26cd34737981666c7c6e
4
+ data.tar.gz: c6e51282c424924bc93687e7ea157951f7749c46
5
5
  SHA512:
6
- metadata.gz: 16841035311154a192d910ebf5fb73563ef1917e0049b69d09e30d36dd95b8ef7b67cf8a6c1dffa2b1da29317465fef6e8c94769d68b1cc628e66143dc2c3059
7
- data.tar.gz: 7fb2c02ff6b86c5f5128054f24fa3aba0cf40f95313d255695c4d91dfcbd49436b8aa3f375eb2c18d30921ae3cd33d00d22e3811c6d64b47ceee578cc2f6f9c8
6
+ metadata.gz: 7f9f20da264b4290f6654d8b36a0a70ca45f30ded8e452400c48d6dbd7909d57651a85f57d0edfd45f7241a55456bd5ea41eecb888411a4cef9667d372ff3873
7
+ data.tar.gz: 94a6cb2137d2ca74549c948d1675bad9c939e626581411126c6d943d94537a8029576fdf66e1dbd8760d124c7da685113cb6068873563ea3ebadb34a47b0c0f9
data/README.md CHANGED
@@ -12,6 +12,27 @@ Requirements
12
12
  * The `mail` gem
13
13
  * The `paint` gem
14
14
 
15
+ Optionally, you can install the `rb-inotify` gem. This will make a
16
+ special watching method available for you (see below).
17
+
18
+ Installation
19
+ ------------
20
+
21
+ mlmmj-rbarchive is available from RubyGems. Install it as usual:
22
+
23
+ ```
24
+ $ gem install mlmmj-rbarchiver.gem
25
+ ```
26
+
27
+ Alternatively, you can build the very latest code from Git:
28
+
29
+ ```
30
+ $ git clone git://github.com/Quintus/mlmmj-rbarchive.git
31
+ $ cd mlmmj-rbarchive
32
+ $ rake gem
33
+ $ gem install pkg/mlmmj-rbarchiver-*.gem
34
+ ```
35
+
15
36
  Usage
16
37
  -----
17
38
 
@@ -61,7 +82,7 @@ below a directory `output` below the current directory. To actually
61
82
  add an mlmmj ML do the following:
62
83
 
63
84
  ``` ruby
64
- a << "/var/spool/mlmmj/my-ml
85
+ a << "/var/spool/mlmmj/my-ml"
65
86
  ```
66
87
 
67
88
  Note you don’t have to specify the "archive" directory below `my-ml`
@@ -78,25 +99,23 @@ they are already nicely sorted:
78
99
  a.preprocess_mlmmj_mails!
79
100
  ```
80
101
 
81
- After having prepared all existing mail, you can now watch the ML’s
82
- +archive+ directories for changes rather than running the
83
- Archiver#preprocess_mlmmj_mails! method periodically:
102
+ You have to rerun this method each time you want to update the HTML
103
+ mail archive. If you have the `rb-inotify` gem installed however, you
104
+ can leverage Linux’ _inotify_ utility and watch the MLs’ directories for
105
+ mails instead:
84
106
 
85
107
  ``` ruby
86
108
  a.watch_mlmmj_mails!
87
109
  ```
88
110
 
89
- Note that the above only works if you have the `rb-inotify` gem
90
- installed. Finally, start the conversion process:
111
+ This will reprocess the mailinglist as new messages arrive.
112
+
113
+ Finally, start the conversion process:
91
114
 
92
115
  ``` ruby
93
116
  a.archive!
94
117
  ```
95
118
 
96
- You can run this periodically if you want, already processed
97
- messages will not be processed again, only new messages are
98
- added to the web archive.
99
-
100
119
  #### I want more output! ####
101
120
 
102
121
  Do this before you start adding mailinglists to the
@@ -112,18 +131,19 @@ Docs?
112
131
  To get a more thorough documentation, run this:
113
132
 
114
133
  ```
115
- $ rdoc archiver.rb
134
+ $ rake docs
116
135
  ```
117
136
 
118
- You will then end up with some more detailed docs in a directory `doc`
137
+ You will then end up with some more detailed docs in a directory `html`
119
138
  below the current working directory.
120
139
 
121
140
  Links
122
141
  -----
123
142
 
124
- * [Online docs](http://quintus.github.io/mlmmj-rbarchiver)
125
- * [Repository](https://github.com/Quintus/mlmmj-rbarchiver)
126
- * [Issue tracker](https://github.com/Quintus/mlmmj-rbarchiver/issues)
143
+ * [Online docs](http://quintus.github.io/mlmmj-rbarchive)
144
+ * [Online manpage](http://quintus.github.io/mlmmj-rbarchive/man/mlmmj-rbarchiver.1.html)
145
+ * [Repository](https://github.com/Quintus/mlmmj-rbarchive)
146
+ * [Issue tracker](https://github.com/Quintus/mlmmj-rbarchive/issues)
127
147
 
128
148
  License
129
149
  -------
@@ -20,6 +20,6 @@
20
20
  module MlmmjArchiver
21
21
 
22
22
  # Version number
23
- VERSION = "0.0.1"
23
+ VERSION = "0.0.2"
24
24
 
25
25
  end
File without changes
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: mlmmj-rbarchiver
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Marvin Gülker
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-02-01 00:00:00.000000000 Z
11
+ date: 2014-02-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: mail
@@ -71,9 +71,9 @@ extra_rdoc_files:
71
71
  files:
72
72
  - bin/mlmmj-rbarchiver
73
73
  - data/mhonarc-rc.erb
74
+ - man/mlmmj-rbarchiver.1
74
75
  - extra/archive.css
75
76
  - extra/rbarchiver.conf
76
- - extra/man/mlmmj-rbarchiver.1
77
77
  - lib/mlmmj-archiver.rb
78
78
  - lib/mlmmj-archiver/archiver.rb
79
79
  - lib/mlmmj-archiver/version.rb