Instructions to run on startup in OS X (fixes #3)
authorWaldir Pimenta <waldyrious@gmail.com>
Mon, 29 May 2017 14:45:15 +0000 (14:45 +0000)
committerWaldir Pimenta <waldyrious@gmail.com>
Mon, 29 May 2017 14:45:15 +0000 (14:45 +0000)
README.md

index 744e4f3..9923921 100644 (file)
--- a/README.md
+++ b/README.md
@@ -22,10 +22,34 @@ You can build and install this program as any other Cabalized program:
     $ runhaskell Setup.hs install
 
 You also need to make sure that arbtt-capture is started with your X
-session. If you use GNOME or KDE, you can copy the file
-`arbtt-capture.desktop` to `~/.config/autostart/`. You might need to put the
-full path to arbtt-capture in the `Exec` line there, if you did not do a
-system wide installation.
+session:
+- If you use GNOME or KDE, you can copy the file
+  `arbtt-capture.desktop` to `~/.config/autostart/`. You might need to put the
+  full path to arbtt-capture in the `Exec` line there, if you did not do a
+  system wide installation.
+- If you use macOS, you can use `launchd` for this.
+  Create a .plist file like the following
+  (with the path changed to match where arbtt-capture is located in your system):
+  
+  ```xml
+  <?xml version="1.0" encoding="UTF-8"?>
+  <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+  <plist version="1.0">
+      <dict>
+          <key>Label</key>
+          <string>com.foo.arbtt</string>
+          <key>Program</key>
+          <string>/path/to/arbtt-capture</string>
+          <key>RunAtLoad</key>
+          <true/>
+          <key>KeepAlive</key>
+          <true/>
+      </dict>
+  </plist>
+  ```
+  and place it in `~/LaunchAgents/com.foo.arbtt.plist`.
+  (You can replace "foo" with anything, such as your username)
+  This will ensure `arbtt-capture` is started whenever you log in.
 
 If you want to record samples at a different rate than one per minute, you
 will have to pass the `--sample-rate` parameter to arbtt-capture.