Chapter 4. UNIX Utilities

4.1. blaze.sh

4.1.1. Synopsis
4.1.2. Description
4.1.3. Options
4.1.4. Environment Variables
4.1.5. Example Usage
4.1.6. See Also

This chapter provides a thorough description of UNIX® utilities that are shipped with BlazeBlogger.

4.1. `blaze.sh`

blaze allows you to run all BlazeBlogger utilities with a single command.

4.1.1. Synopsis

blaze command [option…]

blaze help|man [command]

blaze -h|-v

4.1.2. Description

blaze provides a common way to run BlazeBlogger utilities with a single command.

4.1.3. Options

4.1.3.1. Command Line Options

-h, --help: Displays usage information and exits.
-v, --version: Displays version information and exits.

4.1.3.2. Available Commands

init, in: Runs blaze-init, a utility that either creates a BlazeBlogger repository, or recovers a previously corrupted one. Refer to Section 3.1, “blaze-init” for a full description of the command usage.
config, cf, cfg: Runs blaze-config, a utility that either displays, or sets BlazeBlogger configuration options. Refer to Section 3.2, “blaze-config” for a full description of the command usage.
add: Runs blaze-add, a utility that adds a blog post or a page to the BlazeBlogger repository. Refer to Section 3.3, “blaze-add” for a full description of the command usage.
edit, ed: Runs blaze-edit, a utility that edits a blog post or a page in the BlazeBlogger repository. Refer to Section 3.4, “blaze-edit” for a full description of the command usage.
remove, rm, del: Runs blaze-remove, a utility that removes a blog post or a page from the BlazeBlogger repository. Refer to Section 3.5, “blaze-remove” for a full description of the command usage.
list, ls: Runs blaze-list, a utility that lists blog posts or pages in the BlazeBlogger repository. Refer to Section 3.6, “blaze-list” for a full description of the command usage.
make, mk: Runs blaze-make, a utility that generates a blog from the BlazeBlogger repository. Refer to Section 3.7, “blaze-make” for a full description of the command usage.
log: Runs blaze-log, a utility that displays the BlazeBlogger repository log. Refer to Section 3.8, “blaze-log” for a full description of the command usage.
help: Displays usage information, either for the utility itself, or for the selected command.
man: Displays a manual page, either for the utility itself, or for the selected command.
version, vs, ver: Displays version information.

4.1.4. Environment Variables

EDITOR: Unless the core.editor option is set, blaze tries to use system-wide settings to decide which editor to use.

4.1.5. Example Usage

Run the blaze-remove command:

~]$ blaze remove -p 4
Successfully removed the page with ID 4.

Display usage of the blaze-config command:

~]$ blaze help config
Usage: blaze-config [-qV] [-b DIRECTORY] [-E EDITOR] OPTION [VALUE...]
       blaze-config -e [-b DIRECTORY]
       blaze-config -h|-v

  -b, --blogdir DIRECTORY     specify a directory in which the BlazeBlogger
                              repository is placed
  -E, --editor EDITOR         specify an external text editor
  -e, --edit                  edit the configuration in a text editor
  -q, --quiet                 do not display unnecessary messages
  -V, --verbose               display all messages
  -h, --help                  display this help and exit
  -v, --version               display version information and exit

Display the manual page for the blaze-init command:
```
~]$ blaze man init
```

4.1.6. See Also

Section 3.1, “blaze-init”: blaze-init creates a BlazeBlogger repository, or recovers a previously corrupted one.
Section 3.2, “blaze-config”: blaze-config displays or sets BlazeBlogger configuration options.
Section 3.3, “blaze-add”: blaze-add adds a blog post or a page to the BlazeBlogger repository.
Section 3.4, “blaze-edit”: blaze-edit edits a blog post or a page in the BlazeBlogger repository.
Section 3.5, “blaze-remove”: blaze-remove removes a blog post or a page from the BlazeBlogger repository.
Section 3.6, “blaze-list”: blaze-list lists blog posts or pages in the BlazeBlogger repository.
Section 3.7, “blaze-make”: blaze-make generates a blog from the BlazeBlogger repository.
Section 3.8, “blaze-log”: blaze-log displays the BlazeBlogger repository log.