docstring

1 files changed, 5 insertions, 1 deletions

diff --git a/src/main.lisp b/src/main.lisp
index 1b4463c..0716dba 100644
--- a/src/main.lisp
+++ b/src/main.lisp
@@ -246,7 +246,8 @@ accounts. So keep it secret, keep it safe."
               path)))
 
 (defun start-from-config (&optional (config-file +default-config-file+))
-  "config file should contain several options:
+  "A config file should contain a single PLIST, specifying several
+options:
 
 :PORT :ADDRESS :DOMAIN :STORE-DIR are all passed to START as-is.
 
@@ -264,6 +265,9 @@ strings. This list is interpeted to be ((HANDLE1 PW1) (HANDLE2 PW2)
 users will be made. You should destroy this file after the initial
 boot up, subsequent boots will not need it, even if it remains
 mentioned in th config file.
+
+:SWANK-PORT, if provided, indicates that a swank server should be
+started, this will allow remote live debugging of the system.
 "
 
   (handler-case