mirror of
https://github.com/containers/podman.git
synced 2025-08-06 11:32:07 +08:00
3fd9f0c028
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>
Podman Documentation
The online man pages and other documents regarding Podman can be found at Read The Docs. The man pages can be found under the Commands link on that page.
Build the Docs
Directory Structure
| Directory | |
|---|---|
| Markdown source for man pages | docs/source/markdown/ |
| man pages aliases as .so files | docs/source/markdown/links/ |
| restructured text for readthedocs.io | docs/rst/ |
| target for output | docs/build |
| man pages | docs/build/man |
| remote linux man pages | docs/build/remote/linux |
| remote darwin man pages | docs/build/remote/darwin |
| remote windows html pages | docs/build/remote/windows |
Support files
| docs/remote-docs.sh | Read the docs/source/markdown files and format for each platform |
| docs/links-to-html.lua | pandoc filter to do aliases for html files |