File: README.rst

package info (click to toggle)
ondir 0.2.3%2Bgit0.55279f03-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, buster, sid, stretch
  • size: 188 kB
  • ctags: 53
  • sloc: ansic: 450; makefile: 70; sh: 13; csh: 2
file content (58 lines) | stat: -rw-r--r-- 1,988 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
OnDir
=====

Introduction
------------
ondir is a small program to automate tasks specific to certain directories. It
works by executing scripts in directories when you enter and leave them.

Scripts in the doc subdirectory show how to automate this when using either
BASH or TCSH.

Getting Started
---------------
1. Add scripts.sh or scripts.tcsh to your startup scripts for BASH or TCSH,
   respectively.
2. Restart your shell.
3. Add an entry to your ~/.ondirrc such as those described below. 
4. Change into the corresponding path.
5. Check for success.

Details
-------
An example of ondirs usefulness is when editing web pages. I have a umask of 077
by default, but when creating web pages in ~/public_html the web content has
to be readable by the user the web server runs as. By adding a path section for
this directory to my ~/.ondirrc, and corresponding enter and leave sub-sections,
any scripts in the enter/leave sub-sections are executed when I enter and leave
the directory, respectively. Here is how the entry in my ~/.ondirrc would look::

  enter /home/athomas/public_html
    umask 022

  leave /home/athomas/public_html
    umask 077

And that's all it does. Simple, but effective. 

ondir takes one parameter, the directory you are leaving.

Note that these scripts will be executed when you pass THROUGH the directory 
as well. Using the preceding example, typing "cd ~/public_html/mywebpage" will 
execute the 'enter' in ~/public_html. The reverse is also true: when leaving 
a path, all 'leave' scripts in the intermediate directories are executed.

A more useful example
---------------------
Ondir is particularly useful with `virtualenv
<http://pypi.python.org/pypi/virtualenv>`_. The following config will
automatically activate virtualenv's when you change into a directory and
deactivate when you move out::

  enter ~/Projects/([^/]+)
    if [ -r .venv ]; then
      . ./.venv/bin/activate
    fi

  leave ~/Projects/([^/]+)
    deactivate > /dev/null 2>&1