From 32858c49a32e0d8a0aa795c51c6f802a89cc9d39 Mon Sep 17 00:00:00 2001 From: Casey Scarborough Date: Tue, 17 Sep 2013 13:41:09 -0400 Subject: [PATCH] Update README.md. --- README.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6ce9cbc..836be60 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This repository holds the code for a simple and easy to use keylogger for Mac OS ## Usage -Start by cloning the repository and running the proper make commands, shown below. By default, the application installs to `/usr/local/bin/keylogger`. +Start by cloning the repository and running the proper make commands, shown below. By default, the application installs to `/usr/local/bin/keylogger`, which can easily be changed in the [`Makefile`](https://github.com/caseyscarborough/keylogger/blob/master/Makefile). `make install` may require root access. ```bash $ git clone https://github.com/caseyscarborough/keylogger && cd keylogger @@ -14,22 +14,35 @@ $ 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/keylogger/blob/master/keylogger.h#L12) if necessary. ```bash -$ sudo keylogger +$ keylogger Logging to: /var/log/keystroke.log ``` +If you'd like the application to run on startup, run the `startup` make target: + +```bash +$ sudo make startup +``` + +## Uninstallation + +You can completely remove the application from your system (including the startup daemon) by running the following command (logs will not be deleted): + +```bash +$ sudo make uninstall +``` + ### 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 +$ keylogger clear Logfile cleared. -Logging to: /var/log/keystroke.log # Specify a logfile location. -$ sudo keylogger ~/logfile.txt +$ keylogger ~/logfile.txt Logging to: /Users/Casey/logfile.txt ```