summaryrefslogtreecommitdiff
path: root/docs/remote-docs.sh
diff options
context:
space:
mode:
authorKir Kolyshkin <kolyshkin@gmail.com>2020-02-12 15:04:24 -0800
committerKir Kolyshkin <kolyshkin@gmail.com>2020-02-13 16:28:31 -0800
commit3fd9f0c028f9dab7c8923629d4dc5d38e594db1a (patch)
tree10e7ec07346aa11a068caa62e737e8e0fc8b51dd /docs/remote-docs.sh
parente74ad3596393a476b7e233da736a610ef19bc4a1 (diff)
downloadpodman-3fd9f0c028f9dab7c8923629d4dc5d38e594db1a.tar.gz
podman-3fd9f0c028f9dab7c8923629d4dc5d38e594db1a.tar.bz2
podman-3fd9f0c028f9dab7c8923629d4dc5d38e594db1a.zip
podman(1): fixes
I saw some bad formatting when reading "man podman-run" and proceeded to fix it. I have now opened a can of worms... This commit tries to fix some of the formatting, wording and other bugs I came across (unfortunately not all of them). Can't list every fix that I made here, but in general: - format lists as such (prepend items with "- "); - format examples as such (enclose in ```...```); - format literal values (option names, literal values) as **bold**; - format man page references as **page**(1). - format replacements (option values) and file names as _italic_; - remove some duplicate info (such as what's the default value); - move option value description to option syntax; - end sentences with a period. To test: ```console $ make docs $ man ./docs/build/man/podman-run.1 ### check terminal formatting $ man -Tps ./docs/build/man/podman-run.1 > podman-run.ps $ ps2pdf podman-run.ps ### optional $ evince podman-run.pdf ### check printer formatting (or use ps viewr ``` NOTE - there is much more to do here; - I haven't checked any factual contents, this is about formatting Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Diffstat (limited to 'docs/remote-docs.sh')
0 files changed, 0 insertions, 0 deletions