Browse Source

Rewrite README file.

Georgi Chorbadzhiyski 12 years ago
parent
commit
ca4a352b8e
1 changed files with 58 additions and 2 deletions
  1. 58
    2
      README

+ 58
- 2
README View File

@@ -1,6 +1,36 @@
1
+fjfs (file-join-fs a.k.a. fudge-fs)
2
+===================================
1 3
 fjfs is FUSE module that implements virtual joining of multiple files as one.
2 4
 
3
-To compile the program run "make".
5
+License
6
+=======
7
+fjfs is released under BSD license.
8
+
9
+Installation
10
+============
11
+fjfs depends on libfuse.
12
+
13
+Documentation
14
+=============
15
+fjfs is controlled using command line parameters. Run fjfs to
16
+see all of the parameters and explanation what every one of them does.
17
+
18
+Development
19
+===========
20
+The development is tracked using git. The repository is hosted at github
21
+at http://github.com/gfto/fjfs
22
+
23
+Installation
24
+============
25
+Clone git repository and then run "make".
26
+
27
+   git clone git://github.com/gfto/fjfs.git
28
+   make
29
+   make install
30
+
31
+Quick start
32
+===========
33
+Install fjfs with "make install".
4 34
 
5 35
 To use it:
6 36
      1. Install the FUSE module
@@ -12,7 +42,7 @@ To use it:
12 42
            echo /etc/passwd >> filelist.txt
13 43
 
14 44
      3. Mount fjfs
15
-           ./fjfs joined.txt filelist.txt
45
+           fjfs joined.txt filelist.txt
16 46
 
17 47
      4. Check the result with
18 48
            cat joined.txt
@@ -21,3 +51,29 @@ To use it:
21 51
 
22 52
      5. Unmount the fs
23 53
            fusermount -u joined.txt && rm joined.txt
54
+
55
+More examples
56
+=============
57
+Join files listed in filelist.txt as test-mount.txt
58
+
59
+   fjfs test-mount.txt filelist.txt
60
+
61
+Join files named testfile*.txt as test-mount.txt
62
+
63
+   fjfs --glob test-mount.txt 'testfile*.txt'
64
+
65
+Join files named testfileX.txt testfileY.txt testfileZ.txt as test-mount.txt
66
+
67
+   fjfs --args test-mount.txt testfileX.txt testfileY.txt testfileZ.txt
68
+
69
+Releases
70
+========
71
+Official releases can be downloaded from fjfs home page which is
72
+
73
+   http://georgi.unixsol.org/programs/fjfs/
74
+
75
+Contact
76
+=======
77
+For patches, bug reports, complaints and so on send e-mail to
78
+
79
+   Georgi Chorbadzhiyski <georgi@unixsol.org>

Loading…
Cancel
Save