From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Sun, 21 Aug 2022 19:10:34 +0000 (+0100)
Subject: prefork-interp: docs
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?a=commitdiff_plain;h=eb69b3e9a16a6cc463a1806822a149a6a08b84f9;p=chiark-utils.git

prefork-interp: docs

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---

diff --git a/cprogs/prefork-interp.c b/cprogs/prefork-interp.c
index 3a999ef..cfab9f8 100644
--- a/cprogs/prefork-interp.c
+++ b/cprogs/prefork-interp.c
@@ -1,12 +1,16 @@
 /*
  * "Interpreter" that you can put in #! like this
  *   #!/usr/bin/prefork-interp [<options>] <interpreter>
+ * to amortise the startup time of a script.
  *
  * Usages:
  *   prefork-interp  [<option> ..] <interpreter>  [<script> [<args> ...]]
  *   prefork-interp  [<option>,..],<interpreter>   <script> [<args> ...]
  *   prefork-interp '[<option> ..] <interpreter>'  <script> [<args> ...]
  *
+ * The script must load a corresponding library (eg Proc::Prefork::Interp
+ * for Perl) and call its preform_initialisation_complete routine.
+ *
  * Options must specify argument mediation approach.
  * Currently the only argument mediation supported is:
  *