v1.5 branch refresh based upon upstream master @ c8677ca89e53e3be7988d54280fce166cc894a7e
[librecmc/librecmc.git] / package / utils / fritz-tools / README.md
1 Userspace utilties for accessing TFFS (a name-value storage usually found in AVM Fritz!Box based devices)
2
3 ## Building
4
5 ```
6 mkdir build
7 cd build
8 cmake /path/to/fritz_tffs_tools
9 make
10 ```
11
12 ## Usage
13
14 All command line parameters are documented:
15 ```
16 fritz_tffs_read -h
17 ```
18
19 Show all entries from a TFFS partition dump  (in the format: name=value):
20 ```
21 fritz_tffs_read -i /path/to/tffs.dump -a
22 ```
23
24 Read a TFFS partition and show all entries (in the format: name=value):
25 ```
26 fritz_tffs_read -i /dev/mtdX -a
27 ```
28
29 Output only the value of a specific key (this will only show the value):
30 ```
31 fritz_tffs_read -i /dev/mtdX -n my_ipaddress
32 ```
33
34 ## LICENSE
35
36 See `LICENSE`:
37
38     This program is free software; you can redistribute it and/or modify
39     it under the terms of the GNU General Public License as published by
40     the Free Software Foundation; either version 2 of the License, or
41     (at your option) any later version.
42
43     This program is distributed in the hope that it will be useful,
44     but WITHOUT ANY WARRANTY; without even the implied warranty of
45     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
46     GNU General Public License for more details.
47
48     You should have received a copy of the GNU General Public License along
49     with this program; if not, write to the Free Software Foundation, Inc.,
50     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.