simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-09-18 17:57:11 +03:00
Code Issues Projects Releases Wiki Activity

;doc: cli, ui, web: consistent boilerplate

Browse Source
This commit is contained in:
Simon Michael 2022-12-11 15:44:09 -10:00
parent e07d290338
commit 600e263a9a
3 changed files with 18 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
hledger-ui/hledger-ui.m4.md
View File

@ -2,24 +2,26 @@
% _author_
% _monthyear_
_man_({{
_notinfo_({{
# NAME
}})
hledger-ui is a terminal interface (TUI) for the hledger accounting tool.
This manual is for hledger-ui _version_.
hledger-ui - robust, friendly plain text accounting (TUI version)
_man_({{
_notinfo_({{
# SYNOPSIS
}})
`hledger-ui [OPTIONS] [QUERYARGS]`\
`hledger ui -- [OPTIONS] [QUERYARGS]`
_man_({{
_notinfo_({{
# DESCRIPTION
}})
This manual is for hledger's terminal interface, version _version_.
See also the hledger manual for common concepts and file formats.
_hledgerdescription_
_web_({{
@ -399,8 +401,6 @@ Reads _files_
# BUGS
The need to precede options with `--` when invoked from hledger is awkward.
`-f-` doesn't work (hledger-ui can't read from stdin).
`-V` affects only the accounts screen.

21
hledger-web/hledger-web.m4.md
View File

@ -2,25 +2,28 @@
% _author_
% _monthyear_
_man_({{
_notinfo_({{
# NAME
}})
hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web _version_.
hledger-web - robust, friendly plain text accounting (Web version)
_man_({{
_notinfo_({{
# SYNOPSIS
}})
`hledger-web [OPTIONS] # run temporarily & browse`\
`hledger-web --serve [OPTIONS] # run without stopping`\
`hledger-web --serve-api [OPTIONS] # run JSON server only`\
`hledger-web [OPTIONS] # run temporarily & browse`\
`hledger-web --serve [OPTIONS] # run without stopping`\
`hledger-web --serve-api [OPTIONS] # run JSON server only`\
`hledger web -- [OPTIONS] [QUERYARGS]` # start from hledger
_man_({{
_notinfo_({{
# DESCRIPTION
}})
This manual is for hledger's web interface, version _version_.
See also the hledger manual for common concepts and file formats.
_hledgerdescription_
_web_({{
@ -422,8 +425,6 @@ Reads _files_
# BUGS
The need to precede options with `--` when invoked from hledger is awkward.
`-f-` doesn't work (hledger-web can't read from stdin).
Query arguments and some hledger options are ignored.

3
hledger/hledger.m4.md
View File

@ -43,7 +43,6 @@ all hledger programs. You can read it on hledger.org, or as an info
manual or man page on your system. It is detailed and not entirely linear,
so you should feel free to skip ahead / skim when needed.
m4_dnl Include the standard description:
_hledgerdescription_
The basic function of the hledger CLI is to read a plain text file describing
@ -61,7 +60,6 @@ You can specify standard input with `-f-`.
Transactions are dated movements of money between two (or more) named
accounts, and are recorded with journal entries like this:
m4_dnl Format as a journal snippet:
_journal_({{
2015/10/16 bought food
expenses:food $10
@ -310,7 +308,6 @@ See [Special characters](#special-characters).
# ENVIRONMENT
m4_dnl Standard LEDGER_FILE description:
_LEDGER_FILE_
**COLUMNS**