https://github.com/codeplea/fsghost

a simple cross-platform command line tool to monitor a directory for file changes
https://github.com/codeplea/fsghost

Last synced: 4 days ago
JSON representation

a simple cross-platform command line tool to monitor a directory for file changes

• Host: GitHub
• URL: https://github.com/codeplea/fsghost
• Owner: codeplea
• License: zlib
• Created: 2016-08-01T20:45:43.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-04-03T18:14:28.000Z (over 7 years ago)
• Last Synced: 2024-11-03T09:33:23.573Z (13 days ago)
• Language: C
• Homepage: https://codeplea.com/fsghost
• Size: 26.4 KB
• Stars: 35
• Watchers: 6
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/codeplea/fsghost.svg?branch=master)](https://travis-ci.org/codeplea/fsghost)

# FsGhost - Cross-Platform File Change Monitoring in C



FsGhost is a *tiny* command-line tool to monitor and notify of file changes in a

given directory. FsGhost works natively on both Windows and Linux and is

self-contained in only 1 C file. Its only dependencies are the operating system

headers for your platform.

## Features

- **ANSI C with no external dependencies**.

- Contained in a single source file.

- Simple.

- Released under the zlib license - free for nearly any use.

## Example Usage

Call `fsghost` with a single argument, the path of the directory you'd like to monitor.

```

mkdir test-dir

fsghost test-dir

```

FsGhost will then monitor that directory. If any files are created, written, or

deleted, FsGhost will write that filename to the standard output.

![Example Usage](./demo.gif)

## Building

You can probably build by simply running `make`. If that doesn't work, try to compile

`main.c`. It should be pretty easy.

## FAQ

### Does FsGhost do polling.

No. FsGhost uses the proper file-system APIs on each platform to get notified when changes take place. This means

that it uses very few system resources when running, and will not bog down your machine. It's made to be run in the background

for long periods of time.

For Windows, FsGhost uses the `ReadDirectoryChangesW` API. For Linux, it uses the `inotify` API.