File: readme.html

package info (click to toggle)
mencal 3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 148 kB
  • ctags: 32
  • sloc: perl: 396; makefile: 2
file content (353 lines) | stat: -rw-r--r-- 20,476 bytes parent folder | download
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>

<head>
  <title>Menstruation calendar</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-2">
</head>

<body bgcolor="#cdd2cd" text="#000000" link="#2c4464" vlink="#2c4464" alink="#2c4464">

<center>

<table border="0" cellspacing="1" cellpadding="0" width="700" bgcolor="#000000">
  <tr>
    <td>
      <table border="0" cellpadding="3" cellspacing="1" width="100%" bgcolor="#ffffff">

        <tr valign="top">
          <td align="left">
            <img align="left" border="0" alt="Kyberdigi Labs" src="http://www.kyberdigi.cz/img/logo.png">
          </td>
          <td align="right">
            <h3>Menstruation calendar</font></h3>
            by <b>C. McCohy &lt;<a href="mailto:mccohy@kyberdigi.cz">mccohy@kyberdigi.cz</a>&gt;</b><br>
            Actual version: <b>2.3</b>
          </td>
        </tr>

        <tr bgcolor="#a8b8c8">
          <td colspan="2" valign="middle">
            <table width="700" border="0" cellpadding="0" cellspacing="0">
              <tr>
                <td>
                  <b>Use your computer for superb timing of all your activities</b>
                </td>
                <td align="right" valign="middle">
                  <a href="http://www.kyberdigi.cz/projects/mencal/index.html"><img border="0" alt="cz" src="http://www.kyberdigi.cz/img/flags/cz.gif"></a>
                  <img border="0" alt="en" src="http://www.kyberdigi.cz/img/flags/en.gif">
                </td>
              </tr>
            </table>
          </td>
        </tr>

        <tr bgcolor="#ffffff">
          <td colspan="2">

            <table width="700" border="0" cellspacing="0" cellpadding="10">
              <tr valign="top">

                <td width="200">
                  <img border="0" alt="" src="http://www.kyberdigi.cz/img/folder_open.png"> <a href="http://www.kyberdigi.cz/">Kyberdigi Labs</a><br>
                  <img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" src="http://www.kyberdigi.cz/img/folder_open.png"> <a href="http://www.kyberdigi.cz/projects/english.html">Projects</a><br>
                  <img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" src="http://www.kyberdigi.cz/img/folder_open.png"> <b>Mencal</b><br>

                  <img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" src="http://www.kyberdigi.cz/img/folder.png"> <a href="english.html#requirements">Requirements</a><br>
                  <img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" src="http://www.kyberdigi.cz/img/folder.png"> <a href="english.html#license">License</a><br>
                  <img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" src="http://www.kyberdigi.cz/img/folder.png"> <a href="english.html#download">Download</a><br>
                  <img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" src="http://www.kyberdigi.cz/img/folder.png"> <a href="english.html#install">Installation</a><br>
                  <img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" src="http://www.kyberdigi.cz/img/folder.png"> <a href="english.html#run">Running mencal</a><br>
                  <img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" src="http://www.kyberdigi.cz/img/folder.png"> <a href="english.html#demo">Examples</a><br>
                  <img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" src="http://www.kyberdigi.cz/img/folder.png"> <a href="english.html#bugs">Known bugs</a><br>
                  <img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" src="http://www.kyberdigi.cz/img/folder.png"> <a href="english.html#changelog">Changelog</a><br>
                  <img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" src="http://www.kyberdigi.cz/img/folder.png"> <a href="english.html#archive">Archive</a><br>
                  <img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" src="http://www.kyberdigi.cz/img/folder.png"> <a href="english.html#other">Misc</a><br>

                  <p>
                  <img border="0" alt="" src="http://www.kyberdigi.cz/img/folder_open.png"> <b>Visitors</b><br>
                  <img border="0" alt="" width="20" height="1" src="http://www.kyberdigi.cz/img/0.gif"><img border="0" alt="" src="http://www.kyberdigi.cz/img/folder.png"><img border="0" align="middle" alt="Counter" src="http://counter.kyberdigi.cz/ukazat?16">
                  <p>

                </td>
                <td width="500">

                  <h2>Menstruation calendar</h2>

                  <b>Mencal</b> is a simple variation of the well-known unix command <tt>cal</tt>. The main difference is that you can have some periodically repeating days highlighted in color. This can be used to track menstruation (or other) cycles conveniently.

                  <hr noshade align="left" width="200">
                  <a name="requirements"></a>
                  <h2>Requirements</h2>

                  This program is written in the <b>perl</b> language. It also uses the unix locales and the system commands <tt>strftime</tt> and <tt>mktime</tt>.
                  I don't know which systems have all those,
                  but at least any linux distribution should provide you with everything necessary for running mencal.

                  <hr noshade align="left" width="200">
                  <a name="license"></a>
                  <h2>License</h2>

                  The software may be freely distributed under the terms of the GPL.<br>
                  You can read the license <a href="http://www.kyberdigi.cz/projects/mencal/license_en.html">here</a>.
                  <p>


                  <hr noshade align="left" width="200">
                  <a name="download"></a>
                  <h2>Download</h2>

                  You can download the complete tarball via HTTP right here.
                  <p>

                  <a href="http://www.kyberdigi.cz/projects/mencal/mencal-2.3.tar.gz">mencal-2.3.tar.gz</a><p>
                  <font size="-2">size: 19169 bytes<br>MD5: e0fa5665b8f7772521bb95379bfdec20</font>
                  <p>

                  <hr noshade align="left" width="200">
                  <a name="install"></a>
                  <h2>Installation</h2>

                  First: unpack the archive
                  <pre>$ tar xzf mencal-2.3.tar.gz</pre>

                  Now enter the directory <b>mencal-2.3</b> that was created.
                  <pre>$ cd mencal-2.3</pre>

                  And that's about all. This directory also contains a tiny <i>README</i> file,
                  a copy of the license and the most important file <b>mencal</b>.
                  You can run this program even as an unprivileged user with the command
                  <tt>./mencal</tt>. You can copy the file to wherever it's convenient for you and run it from there.
                  <p>

                  <hr noshade align="left" width="200">
                  <a name="run"></a>
                  <h2>Running mencal</h2>

                  You run the program like this: 
                  <pre><b>$ mencal [options] [file1 file2 ... -c CONF1 -c CONF2 ... ]</b></pre>

                  Display options:
                  <ul>
                    <li><b>-m</b> or <b>--monday</b> - take monday as the first day of the week
                    (sunday is the default)
                    <li><b>-1</b> - print the current month (default)
                    <li><b>-3</b> - print the previous, current and next month
                    <li><b>-y [yyyy]</b> - print a calendar for the whole year <tt>yyyy</tt>.
                    If the year is not given, the current year is used.
                    <li><b>-q</b> or <b>--quiet</b> - don't print the introduction
                    <li><b>-n</b> or <b>--nocolor</b> - don't use color in the output
                    <li><b>-i COLOR</b> or <b>--icolor COLOR</b> - intersection color
                      (the default is red, other possible are green, blue, yellow, violet,
                      cyan, shiny (intense white) and bold (not really a color))
                  </ul>
                  <p>

                  Menstruation options:<br>
                  <b>-c</b> or <b>--config s=[YYYY]MMDD,l=DD,d=T,n=NAME,f=FILE,c=COLOR</b>
                  <p>
                    The second argument is a comma separated list of options. No spaces are
                    allowed in this list. If no name is specified, 'Unknown' is used.
                    Various -c options or filenames can be set.
                  <ul>
                    <li><b>s,start=[YYYY]MMDD</b> - zatek cyklu (standardn aktuln den)
                    <li><b>l,length=DD</b> -  length of period in days (default 28)
                    <li><b>d,duration=T</b> -  duration of menstruation in days (default 4)
                    <li><b>n,name=NAME</b> - name of subject
                    <li><b>f,file=FILE</b> - filename to save configuration to
                        (only menstruation related variables will be saved)
                    <li><b>c,color=COLOR</b> - color used for menstruation days of subject
                        (available colors are the same as with <b>--icolor</b>,
                      the switch <b>-n</b> will cause this color setting to be ignored)
                  </ul>
                  <p>

                  Informational options:
                  <ul>
                    <li><b>-h</b> or <b>--help</b> - prints help on options
                    <li><b>-V</b> or <b>--version</b> - prints version information
                  </ul>
                  <p>

                  <hr noshade align="left" width="200">
                  <a name="demo"></a>
                  <h2>Examples</h2>

                  <ul>
                    <li><a href="http://www.kyberdigi.cz/projects/mencal/shots/shot1.gif">Example 1</a> - a simple example of three current months
                    <li><a href="http://www.kyberdigi.cz/projects/mencal/shots/shot2.gif">Example 2</a> - an example of a full setting of a particular mentruation cycle in an unusual yellow color
                    <li><a href="http://www.kyberdigi.cz/projects/mencal/shots/shot3.gif">Example 3</a> - a calendar for a whole year for two persons, the settings for one are taken from the file <tt>maruskarc</tt>,
                    the days, when both persons are menstruating, are marked red
                    <li><a href="http://www.kyberdigi.cz/projects/mencal/shots/shot4.gif">Example 4</a> - 
                    the same settings as example 3, no colors (suitable for printing or for some monochrome terminals), without the starting info
                    <li><a href="http://www.kyberdigi.cz/projects/mencal/shots/shot5.gif">Example 5</a> a <a href="http://www.kyberdigi.cz/projects/mencal/shots/shot6.gif">Example 6</a>
                      - a bit over-done ...
                  </ul>
                  <p>

                  <hr noshade align="left" width="200">
                  <a name="bugs"></a>
                  <h2>Known bugs</h2>

                  <b>Incorrect day names displaying</b><br>
                  In some cases of special locales setings the day names are displayed incorrectly.
                  For example if one uses hu_HU, some day names have only one character, which
                  can cause table damage. Thank to Peter Gervai for bug info.<br>
                  <i><b>Solved:</b> upgrade to version 2.3.</i><p>

                  <b>Error message typo</b><br>
                  Micah Anderson wrote about a typo in one of error messages you can see
                  after bad parameter settings.<br>
                  <i><b>Solved:</b> upgrade to version 2.2.</i><p>

                  <b>The 'more' command</b><br>
                  The only real problem occurs when you are using the command <b>more</b> on
                  the colored output, e.g. <tt>$ mencal -y -c c=red | more</tt> ... it all gets
                  messed up<br>
                  <i><b>Solved:</b> use <tt>more&nbsp;-f</tt> or <tt>less&nbsp;-R</tt>.
                  Thanks to Peter K. Gale for this hint.</i>
                  <p>

                  <b>The year must be greater than 1900</b><br>
                  Regrettably you can't use years below 1900. The cause is that <tt>perl</tt>
                  works with years decremented by 1900. So if you use the year <i>2002</i>, perl
                  has to convert it to <i>102</i>. And it of course refuses to use negative numbers. If you have any ideas how to work around this, please tell me.<p>

                  <b>Localisation</b><br>
                  The names of days and months are taken from <b>locales</b>, so it would probably be nice to localize the help and program messages.
                  There are not that many messages, in fact. Well, next time. ;-)
                  <p>

                  <b>Color printing</b><br>
                  I have some messages, that it is impossible to print the colored output on
                  a printer ($ mencal | lpr), that the output on the paper looks really bad.
                  It's possible. I'm sorry, but I don't have any printer to look at it and take 
                  care about. Use the <b>-n</b> switch for non-colored output.
                  <pre>$ mencal <b>-n</b> | lpr</pre>
                  <p>

                  <b>Year change</b><br>
                  While using the <tt>-3</tt> switch for printing of three actual months
                  (i.e. november, december, january) some month is not printed.<br>
                  <i><b>Solved:</b> upgrade to version 2.1, where this bug is already fixed.
                  Thanks to Jra Altmann for bugreport.</i><p>

                  <b>Bugs from version 1.1</b><br>
                  There's only a few lines left from 1.0 and the rest was completely rewritten.
                  The old bugs seem to be gone. The configuration doesn't become invalid after one year and you don't have to set it up again.
                  The brain-damage of the old configuration files has also been eliminated.
                  <p>

                  If you think you found a bug, don't hesitate to use your favourite mail client
                  and <a href="mailto:mccohy@kyberdigi.cz">mail me</a>.
                  <p>


                  <hr noshade align="left" width="200">
                  <a name="changelog"></a>
                  <h2>Changelog</h2>

<pre>

2.3 (Jul 17th, 2003)

- fixed incorrect displaying of some day names

2.2 (May 22nd, 2003)

- fixed error message typo

2.1 (December 9th, 2002)

- bugfix: some months are not printed if '-3' is used
- optimization of counting menstruation days

2.0 (March 29th, 2002)

- initial primitive version total rewrited
- more configurations available
- merging of configurations
- other program switches
- non-colored output
- actual three months can be printed

1.1 (October 25th, 2000)

- configuration can be saved
- some minor bugfixes
- localization (use of locales)

1.0 (mesozoic era)

- initial primitive version
</pre>

                  <hr noshade align="left" width="200">
                  <a name="archive"></a>
                  <h2>Archive</h2>

                  <ul>
                    <li>
                      <a href="http://www.kyberdigi.cz/projects/mencal/mencal-2.3.tar.gz">mencal-2.3.tar.gz</a><br>
                      <font size="-2">Size: 19169, MD5: e0fa5665b8f7772521bb95379bfdec20</font><br>
                    <li>
                      <a href="http://www.kyberdigi.cz/projects/mencal/mencal-2.2.tar.gz">mencal-2.2.tar.gz</a><br>
                      <font size="-2">Size: 19163, MD5: c95eead531482b82f219d9e48c4e8cf7</font><br>
                    <li>
                      <a href="http://www.kyberdigi.cz/projects/mencal/mencal-2.1.tar.gz">mencal-2.1.tar.gz</a><br>
                      <font size="-2">Size: 19157, MD5: 6fc94b9174eb2ac71084b8848d4f5a3d</font><br>
                    <li>
                      <a href="http://www.kyberdigi.cz/projects/mencal/mencal-2.0.tar.gz">mencal-2.0.tar.gz</a><br>
                      <font size="-2">Size: 19109, MD5: abd648a8b195648b2c9bf0fa889ee305</font><br>
                    <li>
                      <a href="http://www.kyberdigi.cz/projects/mencal/mencal-1.1.tar.gz">mencal-1.1.tar.gz</a><br>
                      <font size="-2">Size: 18250, MD5: e862c88897e5d817762ff5bb5054c4a4</font><br>
                  </ul>
                  <p>


                  <hr noshade align="left" width="200">
                  <a name="other"></a>
                  <h2>Misc</h2>

                  I thank Vinil for the his intensive cooperation, inspiration and propagation
                  (the quote about timing is from him too) and JD for testing, moral backing
                  and correction.<p>

                  And here's an inspiring response from the maintainer of the <b>mencal</b> debian package:<p>

                  <i>
                  I really love this script, because nobody but you ever bothered writing it :-)
                  I am very proud of you because you wrote this for your girlfriend and
                  I guess that was an act of love :-)
                  </i>
                  <p>

                </td>
              </tr>
            </table>

          </td>
        </tr>

        <tr bgcolor="#a8b8c8">
          <td colspan="2" valign="middle">
            <table width="700" border="0" cellpadding="0" cellspacing="0">
              <tr>
                <td><a href="http://validator.w3.org/check/referer"><img border="0" align="middle" alt="Valid HTML 4.01" src="http://www.kyberdigi.cz/img/validhtml.png"></a></td>
                <td align="right"><a href="http://www.kyberdigi.cz/"><img border="0" align="middle" alt="Kyberdigi Labs" src="http://www.kyberdigi.cz/img/logo-text.png"></a></td>
              </tr>
            </table>
          </td>
        </tr>

      </table>
    </td>
  </tr>
</table>

</center>

</body>
</html>