org-contrib/org-track.org

   1 #+TITLE:   org-track.el -- Keep current with Org-mode development: M-x org-track-update
   2 #+OPTIONS: H:3 num:nil toc:t \n:nil @:t ::t |:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc ^:{} author:nil
   3 #+STARTUP: odd
   4
   5
   6 [[file:index.org][{Back to Worg's contibutions index}]]
   7
   8 =org-track.el= aims to add a simple interface to track Org-mode's git repository
   9 on http://orgmode.org/w/org-mode.git. For non-git users, an =org-latest.tar.gz=
  10 archive is provided and will be downloaded from
  11 http://orgmode.org/org-latest.tar.gz.
  12
  13 The idea was born in a thread on the great emacs-orgmode mailing list on a
  14 request from Stefan Vollmer: http://article.gmane.org/gmane.emacs.orgmode/15264.
  15
  16 If you run into trouble, drop us a mail on the great
  17 [[mailto:emacs-orgmode@gnu.org][emacs-orgmode Mailinglist]].
  18
  19 # <<usage>>
  20 * Usage
  21
  22   You will need an initial version of the Org-mode distribution in your load
  23   path.  For easy upgrading, add the following to your =.emacs=:
  24
  25   #+begin_src emacs-lisp
  26     (add-to-list load-path "/path/to/org-mode/lisp")
  27     (add-to-list load-path "/path/to/org-mode/contrib/lisp")
  28     (require org-install)
  29     (require org-track)
  30   #+end_src
  31
  32   Adjust at least the variable =org-track-directory=. You can use customize for
  33   this:
  34
  35   : M-x customize-variable RET org-track-directory RET
  36
  37   From now on, to update and compile the current development version of Org-mode
  38   is just a matter of typing:
  39
  40   : M-x org-track-update RET
  41
  42   This will download the current =org-latest.tar.gz=, update the autoloads file
  43   =org-install.el= and (optionally) compile the sources.
  44
  45
  46 # <<org-git-directory>>
  47 * org-track-directoy Layout
  48
  49   The =org-track-directory= is the only variable you'll need to adjust. This is
  50   the directory where your local copy of Org-mode will live. I.e., a sub
  51   directory 'org-mode/' will be added here. Also the file =org-latest.tar.gz= will
  52   be put here (and deleted after updates):
  53
  54   : org-track-directory
  55   :         |-- org-latest.tar.gz (if you download archives)
  56   :         `-- org-mode
  57   :             |-- ...
  58   :             |-- lisp          (add this dir to your loadpath)
  59   :             |-- contrib
  60   :             |   `-- lisp       (add this dir to your loadpath)
  61   :             `-- ...
  62
  63
  64 * Fine-tuning
  65
  66   To see and/or change all the related variables, do:
  67
  68   : M-x customize-group RET org-track RET
  69
  70   Here is a list of all variables the script uses:
  71
  72   - =org-track-directory= :: The directory, where the sub-directory =org-mode/=
  73       lives. Default: =~/.emacs.d/org/lisp=
  74   - =org-track-compile-sources= :: Compile the sources after downloading? Defaults
  75       to =t=.
  76   - =org-track-org-url= :: The package is downloaded from this URL. This denotes
  77       the folder actually (i.e. the URL without the basename =org-latest.tar.gz=).
  78   - =org-track-org-package= :: The name the package itself. Default:
  79       =org-latest.tar.gz=.
  80   - =org-track-remove-package= :: Remove the downloaded package after unpacking?
  81       The default is to keep the archive.
  82
  83
  84 * How it works
  85
  86   The `*.tar.gz' version is extracted without external dependencies (tar-mode).
  87   To make sure that =org-latest.tar.gz= is opened in tar-mode, the code modifies
  88   your `auto-mode-alist':
  89
  90   #+begin_src emacs-lisp
  91     (add-to-list 'auto-mode-alist '("org-latest\\.tar\\.gz\\'" . tar-mode))
  92   #+end_src
  93
  94   The downloaded package can be removed. See the option
  95   =org-git-remove-package=. Default is not to remove =org-latest.tar.gz=.