tagfs/README at master · torotil/tagfs · GitHub

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
tagfs - tag file system

1) Introduction
2) Requirements
3) Installation
4) Usage
5) Tests
6) Contact

---------------------------------------------------------------------
Introduction

tagfs is used to organize your documents using tags.

This document contains basic usage instructions for users. To develop or debug
tagfs see the README.dev file.

---------------------------------------------------------------------
Requirements

* python 2.5, 2.6
* Linux kernel with fuse enabled
* python-fuse installed

---------------------------------------------------------------------
Installation

To install tagfs into your home directory type the following:

$ python setup.py install --home ~/.local

If you haven't already extended your local python path then add the following
to your environment configuration script. For example to your .bashrc:

export PYTHONPATH=~/.local/lib/python:$PYTHONPATH

---------------------------------------------------------------------
Usage

After installation tagfs can be started the following way.

Mount a tagged directory:
$ tagfs -i /path/to/my/items/directory /path/to/my/mount/point

Unmount a tagged directory:
$ fusermount -u /path/to/my/mount/point

---------------------------------------------------------------------
Tests

You can execute the test cases via the setup.py script in the project's root
directory.

$ python setup.py test

---------------------------------------------------------------------
Contact

* http://wiki.github.com/marook/tagfs
* Markus Pielmeier <markus.pielmeier@gmx.de>