Man Pages

TIBET manpages

wins

  • Markup-driven documentation of all TIBET CLI and project commands.
  • Standardized UNIX man-page format for command line documentation.
  • Automatic generation of both command line and HTML index and pages.
  • Documentation generation fully built-in to project build process.

concepts

TIBET's manual pages (aka "manpages") serve as documentation for the TIBET CLI and other topics. These pages are available both from the command line and from any browser.

You can create your own manpages for any commands, concepts, coding standards, etc. you wish to associate with your project as we'll show in this guide.

When using the tibet help command to view a manpage TIBET prefixes the topic name. TIBET-authored topics always display a tibet- prefix and your own topics typically will display a {project.name}- prefix such as hello-sample for a hello project.

Below we show help on the help command itself via tibet help help:

tibet help help

TIBET-HELP(1)                                                   TIBET-HELP(1)

NAME
    tibet-help - displays help specific to TIBET

SYNOPSIS
    tibet help <topic>

DESCRIPTION
    Displays help for a specific command or the 'tibet' command.

    You can alternatively get usage data via the --usage flag on each command or
    complete help output by using the --help flag on the target command.

EXAMPLES
    List help on the tibet command itself.

    $ tibet

    Usage: tibet <command> <options>

    The tibet command can invoke TIBET built-ins, custom commands,
    tibet make targets, grunt targets, or gulp targets based on your
    project configuration and your specific customizations.

    Use `tibet help <command>` or `tibet <command> --help` for details.

    <command> built-ins include:

        apropos clone config context couch decrypt deploy
        doclint echo electron encrypt freeze help init lint
        make open package path quickstart reflect release
        resource rollup start strip tag tds test thaw tws type
        user version

    Project `make` targets include:

        build build_docs build_electron build_resources
        check_package check_tests checkup clean clean_build
        clean_docs clean_lint clean_logs

    <options> always include:

        --help         display command help text
        --usage        display command usage summary
        --color        colorize the log output [true]
        --verbose      work with verbose output [false]
        --debug        turn on debugging output [false]
        --stack        display stack with error [false]

    Use 'tibet config' to configure TIBET for your project.

    hello@0.1.0 /Users/ss/.nvm/v0.10.36/bin/tibet

                            July 2019                           TIBET-HELP(1)

Authoring Help

You can create your own manpages for topics in your applications by creating markdown files and placing them in the ~app/doc/markdown directory. By default all TIBET projects include a {project.name}-sample.md file in this directory to give you a starting point.

Generating Help

Use the tibet build_docs target to specifically build docs.

Use tibet build to build your entire project, including documentation.

commands (TIBET)

apropos(1)
-- search for docs matching a keyword
build(1)
-- build project deployment packages
clone(1)
-- clone a project from a template
config(1)
-- manage/display TIBET configuration
context(1)
-- display context information to stdout
couch(1)
-- manage CouchDB databases and apps
decrypt(1)
-- decrypt a string using TDS.decrypt
deploy(1)
-- deploy an application to a target
doclint(1)
-- validate method comment content
echo(1)
-- echo command line arguments to stdout
electron(1)
-- start a TIBET electron application
encrypt(1)
-- encrypt a string using TDS.encrypt
freeze(1)
-- freeze a project's TIBET library version
help(1)
-- display help specific to TIBET
init(1)
-- initialize a TIBET project
lint(1)
-- run lint suite on package files
make(1)
-- run a TIBET makefile.js target
open(1)
-- open a file using OS open command
package(1)
-- list package assets as paths or nodes
path(1)
-- resolve and print virtual path value
quickstart(1)
-- output first steps for new users
reflect(1)
-- reflect on TIBET objects and methods
release(1)
-- perform git tasks to test/tag a release
resource(1)
-- build inline resource and config entries
rollup(1)
-- concatenate a package@config's resources
start(1)
-- start a project server or application
tds(1)
-- start/manage the TIBET Data Server
test(1)
-- run project unit/functional tests
thaw(1)
-- thaw a frozen project's TIBET version
tws(1)
-- manage a TIBET workflow system
type(1)
-- create a new TIBET type
user(1)
-- add/update user configuration data
version(1)
-- manage current project/TIBET version

code

The code for all CLI commands is found in ~/lib/src/tibet/cli.

The build tasks build and build_docs are found in ~app/cmd/make along with all tibet make targets specific to your project.

The markdown files for TIBET CLI commands are found in ~lib/doc/markdown (a parallel directory to where your own project-specific source documentation would reside).