22
33![ ci] ( https://github.com/nowsecure/fsmon/actions/workflows/ci.yml/badge.svg?branch=master )
44
5- FileSystem Monitor utility that runs on Linux, Android, iOS and OSX .
5+ Filesystem Monitor utility for Linux, Android, iOS and macOS .
66
7- Brought to you by Sergi Àlvarez at Nowsecure and distributed under the MIT license.
7+ Brought to you by * Sergi Àlvarez* at ** Nowsecure** and distributed under the ** MIT** license.
88
9- Contact: pancake@nowsecure.com
9+ ** Contact** : pancake@nowsecure.com
10+
11+ ## Installation
12+
13+ On ** macOS** you can now install it via brew with these commands:
14+
15+ ``` bash
16+ brew tap nowsecure/fsmon https://github.com/nowsecure/fsmon
17+ brew install nowsecure/fsmon/fsmon
18+ ```
19+
20+ Alternatively just run ` make ` or pick the builds from the [ release] ( https://github.com/nowsecure/fsmon/releases ) page.
21+
22+ ``` bash
23+ make
24+ make install PREFIX=/usr
25+ ```
1026
1127## Usage
1228
1329The tool retrieves file system events from a specific directory and shows them in colorful format or in JSON.
1430
1531It is possible to filter the events happening from a specific program name or process id (PID).
1632
17- ```
33+ ``` console
1834$ ./fsmon -h
1935Usage: ./fsmon-macos [-Jjc] [-a sec] [-b dir] [-B name] [-p pid] [-P proc] [path]
2036 -a [sec] stop monitoring after N seconds (alarm)
@@ -38,8 +54,7 @@ Examples:
3854$
3955```
4056
41- Backends
42- --------
57+ ## Backends
4358
4459fsmon filesystem information is taken from different backends depending on the operating system and apis available.
4560
@@ -52,31 +67,42 @@ This is the list of backends that can be listed with `fsmon -L`:
5267* kdebug (bsd?, xnu - requires root)
5368* fsevapi (osx filesystem monitor api)
5469
55- Compilation
56- -----------
70+ ## Compilation
5771
5872fsmon is a portable tool. It works on iOS, OSX, Linux and Android (x86, arm, arm64, mips)
5973
6074* Linux*
6175
62- $ make
76+ ``` bash
77+ $ make
78+ ```
6379
6480* OSX + iOS fatbin*
6581
66- $ make
82+ ``` bash
83+ $ make
84+ ```
6785
6886* iOS*
6987
70- $ make ios
88+ ``` bash
89+ $ make ios
90+ ```
7191
7292* Android*
7393
74- $ make android NDK_ARCH=<ARCH> ANDROID_API=<API>
94+ ``` bash
95+ $ make android NDK_ARCH=< ARCH> ANDROID_API=< API>
96+ ```
7597
7698To get fsmon installed system wide just type:
7799
78- $ make install
100+ ``` bash
101+ $ make install
102+ ```
79103
80104Changing installation path...
81105
82- $ make install PREFIX=/usr DESTDIR=/
106+ ``` bash
107+ $ make install PREFIX=/usr DESTDIR=/
108+ ```
0 commit comments