From e4764fb1ed3eb46b6e29cf53455b8b20c5a86331 Mon Sep 17 00:00:00 2001
From: "Kali Kaneko (leap communications)" <kali@leap.se>
Date: Fri, 9 Jun 2017 15:12:41 +0200
Subject: [docs] documentation about helpers

---
 docs/hacking/osx.rst | 39 +++++++++++++++++++++++++++++++++++----
 1 file changed, 35 insertions(+), 4 deletions(-)

diff --git a/docs/hacking/osx.rst b/docs/hacking/osx.rst
index e80f1d97..8b438e0f 100644
--- a/docs/hacking/osx.rst
+++ b/docs/hacking/osx.rst
@@ -3,7 +3,7 @@
 Setting up a development environment in OSX™
 ============================================
 
-(work in progress)
+.. note: work in progress
 
 * Make sure you're using a new enough version of pip (1.8 or newest).
 This will make all the problems with ``cryptography`` going away, since it will
@@ -19,6 +19,26 @@ workaround in an issue in qutebrowser's repo, works fine for me for now::
   https://raw.githubusercontent.com/Homebrew/homebrew/f802822b0fa35ad362aebd0101ccf83a638bed37/Library/Formula/{py,}qt5.rb
   brew install qt5 pyqt5
 
+Privileged helper
+=================
+
+The OSX privileged helper is in ``src/leap/bitmask/vpn/fw/osx/``.
+
+.. note: move it to vpn/helpers/osx
+
+It is a python daemon that runs as root.
+It should be installed by the Bitmask installer.
+
+If you have to stop it::
+
+  sudo launchctl unload /Library/LaunchDaemons/se.leap.bitmask-helper.plist
+
+
+And, to load it again::
+
+  sudo launchctl load /Library/LaunchDaemons/se.leap.bitmask-helper.plist
+
+
 Debugging bitmask-helper
 ------------------------
 
@@ -30,15 +50,26 @@ tear down the firewall after a crash), you can do it like this with
   echo 'firewall_stop/CMD' | socat - UNIX-CONNECT:/tmp/bitmask-helper.socket
 
 
+Other helpers
+-------------
+
+There are other helpers that the installer drops in a well-know path.
+These are shipped in ``pkg/osx``, and copied to
+``/Applications/Bitmask.app/Contents/Resources``.
+
+.. note: cleanup unused helpers
+
+
 Other notes
------------
+===========
 
-PySide vs QtWebKit:
+PySide vs QtWebKit
+------------------
 
 http://qtwebkit.blogspot.nl/2016/08/qtwebkit-im-back.html
 
 Running OSX on KVM
-==================
+------------------
 
 The following notes are not yet tested, but might be useful for development.
 
-- 
cgit v1.2.3