logtalk_doclet(1)

NAME
logtalk_doclet - Logtalk script for automating running doclets

SYNOPSIS
logtalk_doclet -v
logtalk_doclet [-p prolog ] [-d results ] [-t timeout ] [-s prefix ] [-- arguments ]
logtalk_doclet -h

DESCRIPTION
logtalk_doclet is a script for automating running Logtalk doclets. This script runs doclets found on a directory and recursively in its sub-directories by scanning for doclet.lgt and doclet.logtalk source files. The script assumes that the doclets use an initialization/1 directive to automatically run the documentation generation goal at loading time. A non-zero exit status is returned in case of failed doclets, timed out doclets, or crashed doclets.

OPTIONS

-v  Print script version.

-p  Back-end Prolog compiler. Default is YAP. The following identifiers are used: B-Prolog - b, CxProlog - cx, ECLiPSe - eclipse, GNU Prolog - gnu, JIProlog - ji, Lean Prolog - lean, Qu-Prolog - qp, SICStus Prolog - sicstus, SWI-Prolog - swi, SWI-Prolog with Logtalk pack - swipack, XSB - xsb, XSB-MT - xsbmt, YAP - yap.

-d  Directory to store the doclet running logs. Default is the local ./logtalk_doclet_logs directory.

-t  Timeout in seconds for running each doclet. Default is 0; i.e. disabled.

-s  Path prefix to supress when printing doclet paths. Default is the empty string.

--  Arguments to be passed to the integration script used to run the doclets (no default).

-h  Provide help on script usage.

EXIT STATUS

0   All doclets succeeded and there are no timed out or crashed doclets.

1   Some doclets failed but there are no timed out or crashed doclets.

3   One or more doclets timed out while executing but there are no crashed doclets.

7   One or more doclets crashed the process running them.

ENVIRONMENT

LOGTALKHOME
    Specifies the location of the Logtalk installation.

LOGTALKUSER
    Specifies the location of the Logtalk user directory.

FILES

$LOGTALKUSER/library/tester_versions.lgt
    Logtalk source file used for printing the Logtalk and back-end Prolog compiler versions.

SEE ALSO
The Logtalk website at <https://logtalk.org/>

The Logtalk User and Reference Manuals at $LOGTALKHOME/manuals/index.html

AUTHOR
Paulo Moura <pmoura@logtalk.org>

COPYRIGHT
Copyright (c) 1998-2017 Paulo Moura.