Document Dream.run ?socket_path

aantron · Nov 12, 2023 · 78cf84a · 78cf84a
1 parent cb60070
commit 78cf84a
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/dream.mli b/src/dream.mli
@@ -2120,6 +2120,8 @@ val run :
     - [~interface] is the network interface to listen on. Defaults to
       ["localhost"]. Use ["0.0.0.0"] to listen on all interfaces.
     - [~port] is the port to listen on. Defaults to [8080].
+    - If [~socket_path] is specified, Dream will listen on a Unix domain socket
+      at the given path, and ignore [~interface] and [~port].
     - [~stop] is a promise that causes the server to stop accepting new
       requests, and {!Dream.run} to return. Requests that have already entered
       the Web application continue to be processed. The default value is a