10.1 During development
AllApplicationManualNameSummaryHelp

  • Documentation
    • Reference manual
    • Packages
      • SWI-Prolog Source Documentation Version 2
        • Running the documentation system
          • During development
            • doc_collect/1
            • doc_server/1
            • doc_server/2
            • doc_browser/0
            • doc_browser/1
Availability::- use_module(library(doc_http)).(can be autoloaded)
Sourcedoc_server(?Port, +Options)
Start documentation server at Port using Options. Provided options are:
root(+Path)
Defines the root of all locations served by the HTTP server. Default is /. Path must be an absolute URL location, starting with / and ending in /. Intented for public services behind a reverse proxy. See documentation of the HTTP package for details on using reverse proxies.
edit(+Bool)
If false, do not allow editing, even if the connection comes from localhost. Intended together with the root option to make pldoc available from behind a reverse proxy. See the HTTP package for configuring a Prolog server behind an Apache reverse proxy.
allow(+HostOrIP)
Allow connections from HostOrIP. If Host is an atom starting with a’.', suffix matching is preformed. I.e. allow('.uva.nl') grants access to all machines in this domain. IP addresses are specified using the library(socket) ip/4 term. I.e. to allow access from the 10.0.0.X domain, specify allow(ip(10,0,0,_)).
deny(+HostOrIP)
Deny access from the given location. Matching is equal to the allow option.

Access is granted iff

  • Both deny and allow match
  • allow exists and matches
  • allow does not exist and deny does not match.