/usr/lib/swipl/library/ext/pldoc/pldoc/doc_man.pl
All Application Manual Name SummaryHelp

  • pldoc
    • pldoc
      • doc_process.pl -- Process source documentation
      • doc_register.pl
      • doc_modes.pl -- Analyse PlDoc mode declarations
      • doc_wiki.pl -- PlDoc wiki parser
      • doc_util.pl -- PlDoc utilities
      • man_index.pl -- Index the HTML manuals
      • doc_html.pl -- PlDoc HTML backend
      • doc_man.pl -- Process SWI-Prolog HTML manuals
        • man_content_tree/2
        • man_packages_tree/1
        • man_page//2
        • man_synopsis//2
        • man_overview//1
        • doc_object_link//2
        • doc_object_href/2
      • doc_search.pl -- Search form and reply
      • doc_index.pl -- Create indexes
      • doc_htmlsrc.pl -- HTML source pretty-printer
      • doc_colour.pl -- Source colouring support
      • doc_access.pl
      • doc_pack.pl -- PlDoc for Prolog extension packs
      • doc_words.pl -- Reason about Prolog jargon
 man_page(+Obj, +Options)// is semidet
Produce a Prolog manual page for Obj. The page consists of a link to the section-file and a search field, followed by the predicate description. Obj is one of:
  • Name/Arity Predicate indicator: display documentation of the predicate
  • f(Name/Arity) display documentation of an arithmetic function
  • c(Function) display documentation of a C API function
  • section(Level, Number, Id, File) Display a section of the manual
  • sec(DocFile#Id) Display a section of the manual (from short form)

Options:

no_manual(Action)
If Action = fail, fail instead of displaying a not-found message.
synopsis(Bool)
If false, omit the synopsis line
links(Bool)
If true (default), include links to the parent object; if false, just emit the manual material.
navtree(Bool)
If true (default), display the navigation tree, otherwise suppress it.