v/OSX-Keylogger
1
0
Fork 0
mirror of https://github.com/caseyscarborough/keylogger.git synced 2020-11-18 19:53:40 -08:00
Code Issues Releases Wiki Activity

Update README.md.

Browse Source
This commit is contained in:
Casey Scarborough 2013-09-16 21:26:09 -04:00
parent 24e6cb4de9
commit 4a1e66b674
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -8,17 +8,31 @@ Start by cloning the repository and running the proper make commands, shown belo
```bash
$ git clone https://github.com/caseyscarborough/keylog && cd keylog
$ make
$ make install
$ make && make install
```
The application by default logs to `/var/log/keystroke.log`, which may require root access depending on your system's permissions. You can change this in [`keylogger.h`](https://github.com/caseyscarborough/keylog/blob/master/keylogger.h#L14) if necessary.
The application by default logs to `/var/log/keystroke.log`, which may require root access depending on your system's permissions. You can change this in [`keylogger.h`](https://github.com/caseyscarborough/keylog/blob/master/keylogger.h#L12) if necessary.
```bash
$ sudo keylogger
Logging to: /var/log/keystroke.log
```
### Optional Parameters
You can pass in two optional parameters to the program. The `clear` option will clear the logs at the default location. Any other argument passed in will be used as the path to the log file for that process. See below:
```bash
# Clear the logfile.
$ sudo keylogger clear
Logfile cleared.
Logging to: /var/log/keystroke.log
# Specify a logfile location.
$ sudo keylogger ~/logfile.txt
Logging to: /Users/Casey/logfile.txt
```
## Contributing
Feel free to fork the project and submit a pull request with your changes!