cmines(6)

NAME
cmines - minesweeper for the Linux console

SYNOPSIS
cmines [-cehrtv] [-s FILE] [CONFIG]

DESCRIPTION
cmines is an implementation of the game of minesweeper for the Linux console.

The object of the game is to expose all the cells in a rectangular grid which are not mined. When an unmined cell is exposed, the number of neighboring cells which are mined is shown. By applying this information, you attempt to proceed through the minefield.

OPTIONS

-c  Accept mouse clicks at the time the button is pressed. By default, left and right mouse clicks have no effect until the button is released, and then only if the mouse has not been moved off of the cell over which it was pressed. Use of this option removes this "safety feature".

-e  Display emoticons indicating the current status. By default, no emoticons are displayed.

-h  Display a brief summary of the command-line options and exit.

-r  Accept mouse clicks to the right of a cell. By default, mouse clicks are ignored unless the mouse cursor is directly over a cell.

-q  Play quietly; don't ring the bell during the game.

-s FILE
    Use FILE as the configuration file instead of the default.

-t  Update the timer continuously. By default, the timer is only updated when a key is pressed, or when a mouse button is pressed or released. This is done because updating the screen necessarily erases the mouse cursor. Using this option causes the mouse cursor to disappear while it is not moving. (This option is automatically enabled if no mouse support is available.)

-v  Display version information and exit.

CONFIG
    Select CONFIG as the starting configuration.

KEY COMMANDS
While a game is in progress, the keys listed here have the following effects.

hjkl
    The vi keys move the cursor in the traditional fashion (h=left, j=down, k=up, l=right).

HJKL
    Using shift moves the cursor three steps at a time.

arrows
    The arrow keys can be used for movement as well.

.   Place a flag on the current cell. Use this to mark cells you believe to be mined.

space
    Expose the current cell. If the current cell is already exposed, the spacebar behaves as per the enter key. If the current cell is flagged, nothing happens.

enter
    Expose the unflagged neighbors of the current cell. If there are fewer flagged neighbors than the number of mined neighbors, nothing happens. If there are more flags than mines, a warning bell is rung.

p   Peek at the current cell. If the cell is mined, a warning bell is rung; otherwise the cell is exposed. (This command is provided to help relieve frustration when one is truly stuck and a little assistance would permit one to continue playing further.) Peeking automatically disqualifies a game from setting a new record.

q   Quit. The current game is ended.

Q   Quit the program.

Ctrl-L
    Redraw the screen.

?   Display online help. The complete list of configurations, and your best times for each, are also displayed.

After a game has ended, or before a new game has started, the following key commands are available:

n   Start a new game with the same configuration. This key is ignored if a game is currently in progress.

q   Quit the program.

You may also type the initial letter of a configuration to use that configuration for the next game.

MOUSE COMMANDS
While a game is in progress, the mouse buttons operate as follows:

left
    Expose the selected cell, or expose its neighbors if the cell is already exposed.

right
    Flag the selected cell.

middle
    Expose the selected cell's neighbors.

Using the left and right buttons simultaneously is equivalent to using the middle button.

CONFIGURATIONS
By default, there are three configurations: Beginner, Intermediate, and Expert. These configurations can be changed, and others may be added, by editing the configuration file, which by default is the file .cminesrc in your home directory.

Each line of this file should be in the following format:

NAME: WIDTH HEIGHT MINES ...

NAME
    The name of the configuration. Every configuration must begin with a unique letter. (It is also inadvisable to begin a configuration with the letters n or q.)

WIDTH
    The width of the playing field.

HEIGHT
    The height of the playing field.

MINES
    The number of mines to locate.

At the end of the line, your best time for that configuration is stored.

FILES

~/.cminesrc
    The default configuration file.

LICENSE
cmines is copyright (C) 2000 by Brian Raiter <breadbox@muppetlabs.com>.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the file COPYING, included in the distribution, for more details.