"Fossies" - the Fresh Open Source Software Archive

Member "etmtk-3.2.31/README.txt" (26 Apr 2014, 7808 Bytes) of package /linux/privat/etmtk-3.2.31.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 etm Tk
    2 
    3 manage events and tasks using simple text files
    4 etm is an acronym for event and task manager.
    5 
    6 In contrast to most calendar/todo applications, creating items (events,
    7 tasks, and so forth) in etm does not require filling out fields in a
    8 form. Instead, items are created as free-form text entries using a
    9 simple, intuitive format and stored in plain text files.
   10 
   11 This project is hosted on GitHub.
   12 
   13 Sample entries
   14 --------------
   15 
   16 Items in etm begin with a type character such as an asterisk (event) and
   17 continue on one or more lines either until the end of the file is
   18 reached or another line is found that begins with a type character. The
   19 beginning type character for each item is followed by the item summary
   20 and then, perhaps, by one or more @key value pairs. The order in which
   21 such pairs are entered does not matter.
   22 
   23 -   A sales meeting (an event) [s]tarting seven days from today at
   24     9:00am and [e]xtending for one hour with a default [a]lert 5 minutes
   25     before the start:
   26 
   27         * sales meeting @s +7 9a @e 1h @a 5
   28 
   29 -   The sales meeting with another [a]lert 2 days before the meeting to
   30     (e)mail a reminder to a list of recipients:
   31 
   32         * sales meeting @s +7 9a @e 1h @a 5
   33           @a 2d: e; who@when.com, what@where.org
   34 
   35 -   Prepare a report (a task) for the sales meeting [b]eginning 3 days
   36     early:
   37 
   38         - prepare report @s +7 @b 3
   39 
   40 -   A period [e]xtending 35 minutes (an action) spent working on the
   41     report yesterday:
   42 
   43         ~ report preparation @s -1 @e 35
   44 
   45 -   Get a haircut (a task) on the 24th of the current month and then
   46     [r]epeatedly at (d)aily [i]ntervals of (14) days and, [o]n
   47     completion, (r)estart from the completion date:
   48 
   49         - get haircut @s 24 @r d &i 14 @o r
   50 
   51 -   Payday (an occasion) on the last week day of each month. The &s -1
   52     part of the entry extracts the last date which is both a weekday and
   53     falls within the last three days of the month):
   54 
   55         ^ payday @s 1/1 @r m &w MO, TU, WE, TH, FR &m -1, -2, -3 &s -1
   56 
   57 -   Take a prescribed medication daily (a reminder) [s]tarting today and
   58     [r]epeating (d)aily at [h]ours 10am, 2pm, 6pm and 10pm [u]ntil (12am
   59     on) the fourth day from today. Trigger the default [a]lert zero
   60     minutes before each reminder:
   61 
   62         * take Rx @s +0 @r d &h 10, 14, 18, 22 &u +4 @a 0
   63 
   64 -   Move the water sprinkler (a reminder) every thirty mi[n]utes on
   65     Sunday afternoons using the default alert zero minutes before each
   66     reminder:
   67 
   68         * Move sprinkler @s 1 @r w &w SU &h 14, 15, 16, 17 &n 0, 30 @a 0
   69 
   70     To limit the sprinkler movement reminders to the [M]onths of April
   71     through September each year change the @r entry to this:
   72 
   73         @r w &w SU &h 14, 15, 16, 17 &n 0, 30 &M 4, 5, 6, 7, 8, 9
   74 
   75     or this:
   76 
   77         @r n &i 30 &w SU &h 14, 15, 16, 17 &M 4, 5, 6, 7, 8, 9
   78 
   79 -   Presidential election day (an occasion) every four years on the
   80     first Tuesday after a Monday in November:
   81 
   82         ^ Presidential Election Day @s 2012-11-06
   83           @r y &i 4 &M 11 &m 2, 3, 4, 5, 6, 7, 8 &w TU
   84 
   85 -   Join the etm discussion group (a task) [s]tarting on the first day
   86     of the next month. Because of the @g (goto) link, pressing Ctrl-G
   87     when the details of this item are displayed in the gui would open
   88     the link using the system default application which, in this case,
   89     would be your default browser:
   90 
   91         - join the etm discussion group @s +1/1
   92           @g http://groups.google.com/group/eventandtaskmanager/topics
   93 
   94 Installation
   95 ------------
   96 
   97 Source installation under OS X, Linux or Windows
   98 
   99 Python 2.7.x or python >= 3.3.0 is required.
  100 
  101 The following python packages are required for etm but are not included
  102 in the python standard library:
  103 
  104 -   dateutil (1.5 is OK but >= 2.1 is strongly recommended)
  105 -   PyYaml (>= 3.10)
  106 -   icalendar (>=3.5 for python 2, >= 3.6 for python 3)
  107 
  108 Tk and the python module tkinter are also required but are typically
  109 already installed on most modern operating systems. If needed,
  110 installation instructions are given at
  111 www.tkdocs.com/tutorial/install.html.
  112 
  113 Installing etm
  114 
  115 Download 'etmtk-x.x.x.tar.gz' from this site, unpack the tarball, cd to
  116 the resulting directory and do the normal
  117 
  118     sudo python setup.py install
  119 
  120 for a system installation. You can then run from any directory either
  121 
  122     $ etm ?
  123 
  124 for information about command line usage or
  125 
  126     $ etm
  127 
  128 to open the etm gui.
  129 
  130 Alternatively, you can avoid doing a system installation and simply run
  131 either
  132 
  133     $ python etm ?
  134 
  135 or
  136 
  137     $ python etm
  138 
  139 or
  140 
  141     $ ./etm
  142 
  143 from this directory.
  144 
  145 Installing Git or Mercurial
  146 
  147 Having one of these version control systems is optional but strongly
  148 recommended!
  149 
  150 With either progam installed, etm will automatically commit any change
  151 made to any data file. You can see the history of your changes either to
  152 a specific file or to any file from the GUI and, of course, you have the
  153 entire range of possibilities for showing changes, restoring previous
  154 versions and so forth from the command line.
  155 
  156 Git
  157 
  158 Download Git from
  159 
  160     http://git-scm.com/downloads
  161 
  162 Install git and then in a terminal enter your personal information
  163 
  164     $ git config --global user.name "John Doe"
  165     $ git config --global user.email johndoe@example.com
  166 
  167 the editor you would like to use
  168 
  169     $ git config --global core.editor vim
  170 
  171 and the diff program
  172 
  173     $ git config --global merge.tool vimdiff
  174 
  175 Usage information can be obtained in several ways from the terminal
  176 
  177     $ git help <verb>
  178     $ git <verb> --help
  179     $ man git-<verb>
  180 
  181 Finally, Pro Git by Scott Chacon is available to read or download at:
  182 
  183     http://git-scm.com/book/en
  184 
  185 If you have been using Mercurial and would like to give Git a try, you
  186 can import your etm Mercurial records into Git as follows:
  187 
  188     $ cd
  189     $ git clone git://repo.or.cz/fast-export.git
  190     $ git init new_temp_repo
  191     $ cd new_temp_repo
  192     $ ~/fast-export/hg-fast-export.sh -r /path/to/etm/datadir
  193     $ git checkout HEAD
  194 
  195 If an "unnamed head" error is reported, try adding --force to the end of
  196 the fast-export line.
  197 
  198 At this point, you should have a copy of your etm datadir in
  199 new_temp_repo along with a directory, .git, that you can copy to the
  200 root of your etm datadir where it will join its Mercurial counterpart,
  201 .hg. You can then delete new_temp_repo.
  202 
  203 You can now open etmtk.cfg for editing and change the setting for
  204 vcs_system to
  205 
  206     vcs_system: git
  207 
  208 Mercurial
  209 
  210 Download Mercurial from
  211 
  212     http://mercurial.selenic.com/
  213 
  214 install it and then create the file ~/.hgrc, if it doesn't already
  215 exist, with at least the following two lines:
  216 
  217     [ui]
  218     username = Your Name <your email address>
  219 
  220 New etm users
  221 
  222 By default, etm will use the directory
  223 
  224     ~/.etm
  225 
  226 The first time you run etm it will create, if necessary, the following:
  227 
  228     ~/.etm/
  229     ~/.etm/etmtk.cfg
  230     ~/.etm/completions.cfg
  231     ~/.etm/reports.cfg
  232     ~/.etm/data/
  233 
  234 If the data directory needs to be created, then a file
  235 ~/.etm/data/sample.txt will be added with illustrative entries.
  236 Similarly, the *.cfg files will be populated with useful entries.
  237 
  238 Previous etm users
  239 
  240 The first time you run etm, it will copy your current configuration
  241 settings from ~/.etm/etm.cfg to ~/.etm/etmtk.cfg. You can make any
  242 changes you like to the latter file without affecting the former.
  243 
  244 You can switch back and forth between etm_qt and etm. Any changes made
  245 to your data files by either one will be compatible with the other one.
  246 
  247 Feedback
  248 --------
  249 
  250 Please share your ideas in the discussion group at GoogleGroups.
  251 
  252 License
  253 -------
  254 
  255 Copyright (c) 2009-2014 Daniel Graham. All rights reserved.
  256 
  257 This program is free software; you can redistribute it and/or modify it
  258 under the terms of the GNU General Public License as published by the
  259 Free Software Foundation; either version 3 of the License, or (at your
  260 option) any later version.