summaryrefslogtreecommitdiff
path: root/README
blob: d8e4a6a93eea9643a21046330976bc69031bc7e6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
codeword is released under the GPL v3.  See LICENSE for details.

words_alpha.txt is released into the public domain.  The original source and
license is available at https://github.com/dwyl/english-words.

To use codeword, run it with a text file containing a list of words and a
series of arguments that define whether each character position is a missing
letter (using period), a numbered letter or a fixed letter.  Also optionally
give it a switch to put it in anagram mode.

For instance:

    codeword words_alpha.txt 1 2 w 2

To search for a four letter word where 'w' is the third character, the first
charater is a different letter, and the same different letter is used in the
second and fourth character position.

    codeword words_alpha.txt . . w .

To search for a four letter where the third character is 'w' and all other
characters can be any letter.

    codeword -a words_alpha.txt k i w i

To search for anagrams of 'kiwi'.  Note that missing letters can also be used
in this mode.  Putting in numbers will raise an error.