cowfortune

A configurable fortune cookie proclaiming cow (and a few other creatures).
To specify the cows in question, you can provide per-user whitelist or blacklist files that will be respected. It is also possible to define options that will be passed to fortune, so you can specify fortune files or length etc. To see a mantis shrimp enabled color explosion make sure to have lolcat installed.

 ________________________________________
( Just go with the flow control, roll    )
( with the crunches, and, when you get a )
( prompt, type like hell.                )
 ----------------------------------------
        o   ^__^
         o  (oo)\_______
            (__)\       )\/\
                ||--WWW |
                ||     ||

Installation

The lazy way:

make && make install

To generate the cowfortune script:

make

To install the cowfortune script and create the configs:

make install

To uninstall only the cowfortune script itself:

make uninstall

To purge the cowfortune script including the configuration:

make purge

To test the environment and requirements:

make test

To clean the local environment:

make clean

|

The default installation location is /usr/bin and could be overriden by either setting the PREFIX and BINDIR env var before running make or by providing those through Makefile.local.

Example to install into /usr/games:

make BINDIR=games install

|

To perform a staged install for packaging, provide the DESTDIR variable to prepend each installed target file.

Example to stage into /tmp:

make DESTDIR=/tmp install

Usage

For the ultimative cow experience, put cowfortune into your .zshrc or .bashrc.

Or if you feel like you need a moo...

cowfortune

Configuration

Cows

All available cows will be read from either COWPATH or cowsay -l.

global configuration:

/etc/cowfortune/whitelist
/etc/cowfortune/blacklist

user configuration:

~/.config/cowfortune/whitelist
~/.config/cowfortune/blacklist

If you don't want to use the whitelist, dont create that file or simply keep it at zero length.

Customization

To pass options to the fortune or cowsay command, use these config file locations:

~/.config/cowfortune/config
/etc/cowfortune/config

Available options:

• LENGTH_SHORT [INTEGER]
  synopsis: Set the longest fortune length (in characters) considered to be 'short'.
  default: 180

• COLUMN_WIDTH [INTEGER]
  synopsis: Specifies roughly where the message should be wrapped.
  default: 50

• LENGTH_USE [short,long,all]
  synopsis: Short, long or all apothegms. See LENGTH_SHORT on which fortunes are considered 'short'.
  default: short

• OFFENSIVE_ONLY [0,1]
  synopsis: Choose only from potentially offensive aphorisms. This option is ignored if a fortune directory/file is specified.
  default: 0

• FORTUNES [FILE...]
  synopsis: Choose only fortunes from specified directory/file. If specified, the OFFENSIVE_ONLY options will be ignored.
  default: undefined

• LOLCAT_IGNORE [0,1]
  synopsis: Choose to ignore the optional lolcat rainbow coloring even when its actually available.
  default: 0

• DEBUG_SOURCE [0,1]
  synopsis: Show the cookie file from which the fortune came.
  default: 0

• DEBUG_COW [0,1]
  synopsis: Show the used and all available cow files after blacklist/whitelist processing.
  default: 0

• DEBUG_FILES [0,1]
  synopsis: Print out the list of files which would be searched, but don't print a fortune.
  default: 0

• DEBUG_OPTIONS [0,1]
  synopsis: Print out the command line arguments that are passed to the fortune command.
  default: 0

Requirements

• cowsay - configurable speaking/thinking cow (and a bit more)
• fortune - print a random, hopefully interesting, adage

Optional:

• lolcat - rainbow coloring for text (requires ruby)