spec md fix

This commit is contained in:
anon 2024-02-10 18:44:19 +01:00
parent 717e04273b
commit e5258351de

View File

@ -27,11 +27,14 @@ which are not standard for every application
+ we are not trying to replace it in anyways; it only makes sense + we are not trying to replace it in anyways; it only makes sense
# CLI # CLI
histui \<verb\>
+ \<import\> \<file-1\>:\<file-2\> [format] ```
+ \<export\> \<file\> [format] histui <verb>
+ \<tui\> \<file\> [options] <import> <file-1>:<file-2> [format]
+ \<init\> \<shell\> <export> <file> [format]
<tui> <file> [options]
<init> <shell>
```
## Import ## Import
Read history entries from \<file-1\> into Read history entries from \<file-1\> into
@ -62,10 +65,13 @@ the available options shall be printed.
# TUI # TUI
```
$ histui tui [options] $ histui tui [options]
--command : start in search mode --command : start in search mode
--normal : start in normal mode --normal : start in normal mode
```
```
+---+---------------+ +---+---------------+
| p | | | p | |
| o | listing | | o | listing |
@ -75,6 +81,7 @@ $ histui tui [options]
+-------------------+ +-------------------+
| input | | input |
+-------------------+ +-------------------+
```
### Modes ### Modes
+ the reason why we have modes is to make both + the reason why we have modes is to make both
@ -140,19 +147,25 @@ Pop result frame.
Echo entry value and exit with success. Echo entry value and exit with success.
## Format ## Format
``` ```
%[flags][width]<specifier> %[flags][width]<specifier>
``` ```
#### flags #### flags
```
- : left-justify within [width] - : left-justify within [width]
\# : relative (has effect on time specifiers) \# : relative (has effect on time specifiers)
```
#### width #### width
+ number of characters to align to + number of characters to align to
#### specifiers #### specifiers
These specifiers root mainly from the C stdlib. These specifiers root mainly from the C stdlib.
```
s : history entry s : history entry
n : entry number n : entry number
p : shell id p : shell id
@ -171,6 +184,7 @@ R : 24h time ("HH:MM")
S : seconds; 0 padded {04} S : seconds; 0 padded {04}
M : minutes; 0 padded {03} M : minutes; 0 padded {03}
T : ISO 8601 time format ("HH:MM:SS") T : ISO 8601 time format ("HH:MM:SS")
```
# Environment # Environment
HISTUIHIST : histuidb to be used HISTUIHIST : histuidb to be used