Procházet zdrojové kódy

spec md fix

undefined
anon před 3 měsíci
rodič
revize
e5258351de
1 změnil soubory, kde provedl 19 přidání a 5 odebrání
  1. +19
    -5
      documentation/specification.md

+ 19
- 5
documentation/specification.md Zobrazit soubor

@@ -27,11 +27,14 @@ which are not standard for every application
+ we are not trying to replace it in anyways; it only makes sense

# CLI
histui \<verb\>
+ \<import\> \<file-1\>:\<file-2\> [format]
+ \<export\> \<file\> [format]
+ \<tui\> \<file\> [options]
+ \<init\> \<shell\>

```
histui <verb>
<import> <file-1>:<file-2> [format]
<export> <file> [format]
<tui> <file> [options]
<init> <shell>
```

## Import
Read history entries from \<file-1\> into
@@ -62,10 +65,13 @@ the available options shall be printed.

# TUI

```
$ histui tui [options]
--command : start in search mode
--normal : start in normal mode
```

```
+---+---------------+
| p | |
| o | listing |
@@ -75,6 +81,7 @@ $ histui tui [options]
+-------------------+
| input |
+-------------------+
```

### Modes
+ the reason why we have modes is to make both
@@ -140,19 +147,25 @@ Pop result frame.
Echo entry value and exit with success.

## Format

```
%[flags][width]<specifier>
```

#### flags

```
- : left-justify within [width]
\# : relative (has effect on time specifiers)
```

#### width
+ number of characters to align to

#### specifiers
These specifiers root mainly from the C stdlib.

```
s : history entry
n : entry number
p : shell id
@@ -171,6 +184,7 @@ R : 24h time ("HH:MM")
S : seconds; 0 padded {04}
M : minutes; 0 padded {03}
T : ISO 8601 time format ("HH:MM:SS")
```

# Environment
HISTUIHIST : histuidb to be used

Načítá se…
Zrušit
Uložit