redict 0.2.0

A TUI and library to work with DICT servers.
Documentation 
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

![redict](https://i.imgur.com/UIl1mRO.jpg)
# redict
A TUI and library to work with DICT servers.

# Using

## Starting

To start `redict` simply do :

```
redict {server}:{port}
```

## Searching

To search, just type the word you want to find the definition of !
You also have two useful tools in the search bar :

  - Prefix anything by `@` and it will select a database
  - Prefix anything by `:` and it will select a matching strategy

Thus :
```
word @database :strategy
```

Means `search "word" in "database" wiht algorithm "strategy"`.

## Navigating

We can split `redict` screen in 3 parts :

- The `Search` bar (top bar)
- The `Status` bar (just below `Search` bar)
- The "mode" space (everything appart the two aforementionned),
  delimited by the mode indicator.

There are generic key bindings :

| Key | Action |
|-----|--------|
| `Esc` | Exit `redict` |
| `PageUp` | Scroll up in the tab page |
| `PageDown` | Scroll down in the tab page |
| `Tab` | Go to next mode |
| `BackTab` | Go to previous mode |
| `Up` | Go up in `Search` bar history |
| `Down` | Go down in `Search` bar history |
| `CTRL-u` | Empty search bar |
| `Enter` | Refreshes current mode, possibly using the currently searched term |
| `Left` | Move search bar cursor to the left |
| `Right` | Move search bar cursor to the right |

Moreover, you can use your keyboard to edit the search bar direclty,
that is anything typed will be added to the search bar.

## Modes

Each mode does a different thing and allows you to view different
informations about the server.

### Define

Shows the definition on the currently searched term.

You can you `CTRL-h` and `CTRL-l` to navigate definitions.

Definitions are listed in the `Sources` bar, at the very bottom of the
screen.

### Match

Shows words matching the currently searched term.

This may be useful if your search show `No definition` in `Define`
mode.

### Strategies

Shows the available matching strategies for this server.

### Databases

Shows the available databases for this server.

# TODO

## Features

I would like to:

- [x] Basically working binary and library
- [ ] Have a better search bar
  - [ ] Database filtering in `Define` and `Match` mode using `database:db` or `db:db`
  - [ ] Strategy picking in `Match` mode using `strat:` or `strategy:`
  - [ ] Completions
- [ ] Enhanced `Info` mode, that englobes `Databases` and `Strategies`, and other informations
- [ ] `Command` mode, to send raw commands
- [ ] Multiple servers, but always in 0-config mode, that is only specified from the command line


## Compliance

This tool is (for now) partly [RFC 2229](https://tools.ietf.org/html/rfc2229)
compliant :

- [x] `DEFINE`
- [x] `MATCH`
- [x] `SHOW`
  - [x] `DATABASES`
  - [x] `STRATEGIES`
  - [ ] `INFO`
  - [ ] `SERVER`
- [x] `CLIENT`
- [ ] `STATUS`
- [ ] `QUIT`
- [ ] `OPTION MIME` (and it will never be)
- [ ] `AUTH`
- [ ] SASL

For now, this tool does not read `dict` URLs, either, but will in the future.
It also does not pipelines the requests, as this is not needed in interactive use.