github.com/wfjm.w11
1
0
Fork 0
mirror of https://github.com/wfjm/w11.git synced 2026-05-01 22:17:08 +00:00
Code Issues Releases Wiki Activity

man pages: spelling/grammar updates [skip ci]

Browse Source
This commit is contained in:
wfjm
2022-05-01 08:35:23 +02:00
parent a5640780d9
commit d1d95504df
32 changed files with 295 additions and 294 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
tools/man/man1/github_md2html.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: github_md2html.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: github_md2html.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2017-2018 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -8,7 +8,7 @@
.TH GITHUB_MD2HTML 1 2018-11-03 "Retro Project" "Retro Project Manual"
.\" ------------------------------------------------------------------
.SH NAME
github_md2html \- convert markdown to html with GitHub API
github_md2html \- convert markdown to HTML with GitHub API
.\" ------------------------------------------------------------------
.SH SYNOPSIS
.
@@ -19,16 +19,16 @@ github_md2html \- convert markdown to html with GitHub API
.
.\" ------------------------------------------------------------------
.SH DESCRIPTION
Converts markdown files to html using the GitHub converter API.
Converts Markdown files to HTML using the GitHub converter API.
\fIFILE\fP can either be a file name or a directory name (e.g. '.').
If it's a directory, the whole sub-tree will be scanned and all files
with an extension of \fI.md\fP will be converted.
The created html files have the extension \fI.md.html\fP.
The created HTML files have the extension \fI.md.html\fP.
Unless the \fB-force\fP option is given the script checks whether the
\fI.md.html\fP
file already exists and converts only when the markdown file is newer than
the html file.
the HTML file.
.
.\" ------------------------------------------------------------------
.SH OPTIONS
@@ -39,11 +39,11 @@ re-create all files, even when they exist and are up-to-date.
.
.\" ----------------------------------------------
.IP "\fB\-standalone\fR"
modify local links for usage with local browser. All links pointing to a
local \fI.md\fP file will be redirected to the \fI.md.html\fP file, and
modify local links for usage with a local browser. All links pointing to a
local \fI.md\fP file will be redirected to the \fI.md.html\fP file and
all links pointing to a local directory will be redirected to a
\fIREADME.md.html\fP in case the directory README exists.
This mode is is useful when one wants to inspect the files directly
This mode is useful when one wants to inspect the files directly
with a browser.
.
.\" ----------------------------------------------
@@ -51,7 +51,7 @@ with a browser.
trace link mapping in \fI-standalone\fP mode.
.\" ----------------------------------------------
.IP "\fB\-verbose\fR"
print status of each inspected file. Default is to list only converted files.
print status of each inspected file. The default is to list only converted files.
.
.\" ----------------------------------------------
.IP "\fB\-context \fIcont\fR"
@@ -67,7 +67,7 @@ print help text.
.
.\" ------------------------------------------------------------------
.SH EXIT STATUS
In case of an error an exit status 1 is returned.
In case of an error, an exit status 1 is returned.
.
.
.\" ------------------------------------------------------------------