Commit ff47c9b6 authored by Bjoern Broetz's avatar Bjoern Broetz

Add readme

parent 9c90592d
# linkbaum
Create a link tree that mirrors a given base folder with all content.
Directories are real, files are links.
# usage
```
linkbaum.py [-h] [-s BASEDIR] [-t TARGETDIR] [-c CUTDIR]
Create a link tree that mirrors a given base folder with all content.
Directories are real, files are links.
optional arguments:
-h, --help show this help message and exit
-s BASEDIR, --source BASEDIR
base folder
-t TARGETDIR, --target TARGETDIR
target folder
-c CUTDIR, --cutdir CUTDIR
folder in the basetree from which the target tree
shall start
```
E.g.:
```
python linkbaum.py -s ./tests/testfolder/ -t ./tests/target/ -c testfolder
```
creates a linktree copy of the original tree
```
tests/
├── target
│   └── testfolder
│   ├── sub1
│   │   ├── file1 -> /mnt/lustre01/pf/b/b309070/dev/linkbaum/tests/testfolder/sub1/file1
│   │   ├── file2 -> /mnt/lustre01/pf/b/b309070/dev/linkbaum/tests/testfolder/sub1/file2
│   │   └── file3 -> /mnt/lustre01/pf/b/b309070/dev/linkbaum/tests/testfolder/sub1/file3
│   ├── sub2
│   │   ├── file1 -> /mnt/lustre01/pf/b/b309070/dev/linkbaum/tests/testfolder/sub2/file1
│   │   └── file2 -> /mnt/lustre01/pf/b/b309070/dev/linkbaum/tests/testfolder/sub2/file2
│   └── sub3
│   ├── file1 -> /mnt/lustre01/pf/b/b309070/dev/linkbaum/tests/testfolder/sub3/file1
│   ├── file2 -> /mnt/lustre01/pf/b/b309070/dev/linkbaum/tests/testfolder/sub3/file2
│   └── file3 -> /mnt/lustre01/pf/b/b309070/dev/linkbaum/tests/testfolder/sub3/file3
└── testfolder
├── sub1
│   ├── file1
│   ├── file2
│   └── file3
├── sub2
│   ├── file1
│   └── file2
└── sub3
├── file1
├── file2
└── file3
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment