ronn-ng 0.10.1.pre1 → 0.10.1.pre3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHORS +11 -7
- data/CHANGES +7 -1
- data/INSTALLING.md +29 -27
- data/LICENSE.txt +1 -1
- data/README.md +15 -9
- data/Rakefile +1 -1
- data/bin/ronn +1 -1
- data/lib/ronn/document.rb +4 -1
- data/lib/ronn/roff.rb +4 -0
- data/lib/ronn/template/default.html +1 -1
- data/lib/ronn.rb +4 -6
- data/man/index.html +15 -14
- data/man/index.txt +10 -9
- data/man/ronn-format.7 +2 -2
- data/man/ronn.1 +25 -20
- data/man/ronn.1.ronn +9 -8
- data/ronn-ng.gemspec +6 -69
- metadata +19 -80
- data/Gemfile +0 -2
- data/Gemfile.lock +0 -70
- data/test/angle_bracket_syntax.html +0 -27
- data/test/angle_bracket_syntax.roff +0 -24
- data/test/angle_bracket_syntax.ronn +0 -22
- data/test/backticks.html +0 -14
- data/test/backticks.ronn +0 -10
- data/test/basic_document.html +0 -8
- data/test/basic_document.ronn +0 -4
- data/test/circumflexes.ronn +0 -1
- data/test/code_blocks.html +0 -38
- data/test/code_blocks.roff +0 -38
- data/test/code_blocks.ronn +0 -41
- data/test/code_blocks_regression +0 -19
- data/test/code_blocks_regression.html +0 -38
- data/test/code_blocks_regression.ronn +0 -40
- data/test/contest.rb +0 -70
- data/test/custom_title_document.html +0 -6
- data/test/custom_title_document.ronn +0 -5
- data/test/definition_list_syntax.html +0 -25
- data/test/definition_list_syntax.roff +0 -19
- data/test/definition_list_syntax.ronn +0 -18
- data/test/dots_at_line_start_test.roff +0 -19
- data/test/dots_at_line_start_test.ronn +0 -12
- data/test/ellipses.roff +0 -7
- data/test/ellipses.ronn +0 -7
- data/test/entity_encoding_test.html +0 -42
- data/test/entity_encoding_test.roff +0 -51
- data/test/entity_encoding_test.ronn +0 -34
- data/test/index.txt +0 -8
- data/test/markdown_syntax.html +0 -954
- data/test/markdown_syntax.roff +0 -907
- data/test/markdown_syntax.ronn +0 -881
- data/test/middle_paragraph.html +0 -14
- data/test/middle_paragraph.roff +0 -9
- data/test/middle_paragraph.ronn +0 -10
- data/test/missing_spaces.roff +0 -7
- data/test/missing_spaces.ronn +0 -2
- data/test/nested_list.ronn +0 -19
- data/test/nested_list_with_code.html +0 -14
- data/test/nested_list_with_code.roff +0 -11
- data/test/nested_list_with_code.ronn +0 -6
- data/test/ordered_list.html +0 -28
- data/test/ordered_list.roff +0 -25
- data/test/ordered_list.ronn +0 -21
- data/test/page.with.periods.in.name.5.ronn +0 -4
- data/test/pre_block_with_quotes.roff +0 -8
- data/test/pre_block_with_quotes.ronn +0 -6
- data/test/section_reference_links.html +0 -16
- data/test/section_reference_links.roff +0 -7
- data/test/section_reference_links.ronn +0 -12
- data/test/single_quotes.html +0 -11
- data/test/single_quotes.roff +0 -5
- data/test/single_quotes.ronn +0 -9
- data/test/tables.ronn +0 -24
- data/test/test_ronn.rb +0 -124
- data/test/test_ronn_document.rb +0 -186
- data/test/test_ronn_index.rb +0 -73
- data/test/titleless_document.html +0 -9
- data/test/titleless_document.ronn +0 -3
- data/test/underline_spacing_test.roff +0 -13
- data/test/underline_spacing_test.ronn +0 -11
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4431d2e6f481e845cf8d537861b4727d1be790186d81e8a574bda9d8b98ac662
|
4
|
+
data.tar.gz: 5490717221cd544bc676c69b3776824a127d7251cd0a11f6df5f9916932e0206
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d02713bcb099fcd2d0ba855f54930b9b7fc268f106d3394c746033c2568813185e86cc0338d047d8d7859263b18271d88f82ae26185eaf8f3d0e3848b34fc2a1
|
7
|
+
data.tar.gz: 2abd13e002ffa4390a35e444daedfa99d00a3d373389b243423606461be763fab8c1dfeaed30e7034f36b9b2262a4560b171a794d056af3bf747c32353ac372d
|
data/AUTHORS
CHANGED
@@ -1,8 +1,12 @@
|
|
1
|
-
#
|
2
|
-
# copyright purposes or whatever.
|
1
|
+
# Ronn-NG Authors
|
3
2
|
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
3
|
+
This is a list of people who have contributed code or ideas to Ronn and Ronn-NG.
|
4
|
+
|
5
|
+
Ryan Tomayko (original Ronn author) <https://github.com/rtomayko>
|
6
|
+
Andrew Janke (main Ronn-NG author) <https://github.com/apjanke>
|
7
|
+
|
8
|
+
Hallison Batista <https://github.com/hallison>
|
9
|
+
Suraj N. Kurapati <https://github.com/sunaku>
|
10
|
+
Takuya Noguchi <https://github.com/tnir>
|
11
|
+
Deivid Rodriguez <https://github.com/deivid-rodriguez>
|
12
|
+
Chris Wanstrath <https://github.com/defunkt>
|
data/CHANGES
CHANGED
@@ -4,15 +4,21 @@ Ronn-NG CHANGES
|
|
4
4
|
Version 0.10.1 (in progress)
|
5
5
|
----------------------------
|
6
6
|
|
7
|
+
Note: The Ronn-NG 0.10.0 release does not exist, due to a RubyGems publishing mistake. 0.10.1 is
|
8
|
+
the first 0.10.x release.
|
9
|
+
|
7
10
|
* Switch to GitHub Flavored Markdown, fixing code block rendering (<https://github.com/apjanke/ronn-ng/pull/53>)
|
8
11
|
* Revert `\[ci]` back to `\(bu)` (<https://github.com/apjanke/ronn-ng/pull/51>)
|
9
12
|
* Minor fix to single-quote escaping (<https://github.com/apjanke/ronn-ng/issues/55>)
|
10
13
|
* Elide HTML comments when producing roff output (<https://github.com/apjanke/ronn-ng/issues/65>)
|
14
|
+
* Remove non-portable `more -i` option (<https://github.com/apjanke/ronn-ng/issues/71>)
|
15
|
+
* Fix charset in HTML output's Content-Type (<https://github.com/apjanke/ronn-ng/pull/83>)
|
11
16
|
* Bump to mustache 1.x
|
12
17
|
|
13
18
|
Version 0.10.0 (never)
|
14
19
|
---------------------------
|
15
|
-
|
20
|
+
|
21
|
+
Doesn't exist due to a RubyGems publishing mistake.
|
16
22
|
|
17
23
|
Version 0.9.1 (2020 Apr 09)
|
18
24
|
---------------------------
|
data/INSTALLING.md
CHANGED
@@ -1,5 +1,4 @@
|
|
1
|
-
Ronn-NG Installation
|
2
|
-
====================
|
1
|
+
# Ronn-NG Installation
|
3
2
|
|
4
3
|
## Installation Process
|
5
4
|
|
@@ -8,7 +7,7 @@ Ronn-NG Installation
|
|
8
7
|
The best way to install Ronn-NG is with a package manager. This is currently
|
9
8
|
only supported on macOS, with [Homebrew](http://brew.sh). To install with `brew`:
|
10
9
|
|
11
|
-
```
|
10
|
+
```bash
|
12
11
|
brew tap apjanke/ronn-ng
|
13
12
|
brew install ronn-ng
|
14
13
|
```
|
@@ -18,7 +17,7 @@ brew install ronn-ng
|
|
18
17
|
Ronn-NG is distributed as a gem package, which can be used if you don't have
|
19
18
|
a supported package manager. Install with rubygems:
|
20
19
|
|
21
|
-
```
|
20
|
+
```bash
|
22
21
|
gem install ronn-ng
|
23
22
|
ronn --help
|
24
23
|
```
|
@@ -32,7 +31,7 @@ completion directories pointing at the files in the installed gem.
|
|
32
31
|
|
33
32
|
In Zsh, you can do something like this:
|
34
33
|
|
35
|
-
```
|
34
|
+
```bash
|
36
35
|
ronn_dist_dir=$(dirname $(dirname $(gem which ronn-ng)))
|
37
36
|
ronn_zsh_dir="$ronn_dist_dir/completion/zsh"
|
38
37
|
ln -s "$ronn_zsh_dir/_ronn" /usr/local/share/zsh/site-functions
|
@@ -40,7 +39,7 @@ ln -s "$ronn_zsh_dir/_ronn" /usr/local/share/zsh/site-functions
|
|
40
39
|
|
41
40
|
In Bash, something like this:
|
42
41
|
|
43
|
-
```
|
42
|
+
```bash
|
44
43
|
ronn_dist_dir=$(dirname $(dirname $(gem which ronn-ng)))
|
45
44
|
ronn_bash_dir="$ronn_dist_dir/completion/bash"
|
46
45
|
ln -s "$ronn_bash_dir/ronn" /usr/local/etc/bash_completion.d
|
@@ -53,46 +52,49 @@ to be a limitation of the `gem` installation mechanism.
|
|
53
52
|
If that `gem which` stuff doesn't work for you, you can `gem install gem-path`
|
54
53
|
and use `gem path ronn-ng` instead.
|
55
54
|
|
56
|
-
|
57
55
|
## Building from Source
|
58
56
|
|
59
|
-
Hacking? Install Ronn-NG from source.
|
57
|
+
Hacking on Ronn? Install Ronn-NG from source.
|
60
58
|
|
61
|
-
Clone the git repository and put ronn/bin on your PATH:
|
59
|
+
Clone the git repository and put `ronn/bin` on your PATH:
|
62
60
|
|
63
|
-
```
|
64
|
-
git clone
|
65
|
-
PATH
|
61
|
+
```bash
|
62
|
+
git clone https://github.com/apjanke/ronn-ng
|
63
|
+
PATH="$(pwd)/ronn-ng/bin:$PATH"
|
66
64
|
```
|
67
65
|
|
68
|
-
The following gems are required for
|
69
|
-
* nokogiri
|
70
|
-
* mustache
|
71
|
-
* kramdown
|
72
|
-
* rubocop
|
73
|
-
* sinatra
|
74
|
-
* rack
|
75
|
-
* rake
|
76
|
-
* test-unit
|
66
|
+
The following gems are required for Ronn-NG development:
|
77
67
|
|
78
|
-
|
79
|
-
|
80
|
-
|
68
|
+
* nokogiri
|
69
|
+
* mustache
|
70
|
+
* kramdown
|
71
|
+
* rubocop
|
72
|
+
* sinatra
|
73
|
+
* rack
|
74
|
+
* rake
|
75
|
+
* test-unit
|
81
76
|
|
82
|
-
|
77
|
+
You can install them locally in your ronn-ng repo with bundler using the project's gem definition:
|
83
78
|
|
84
|
-
```
|
79
|
+
```bash
|
85
80
|
bundle install --with development
|
86
81
|
```
|
87
82
|
|
83
|
+
Or install them "globally" using gem:
|
84
|
+
|
85
|
+
```bash
|
86
|
+
gem install nokogiri mustache kramdown rubocop sinatra rack rake test-unit
|
87
|
+
```
|
88
|
+
|
88
89
|
Then you should be able to make changes directly to your cloned repo and have
|
89
90
|
them be reflected in your active `ronn` command.
|
90
91
|
|
91
92
|
## Legacy Versions
|
92
93
|
|
93
94
|
Historical Ronn tarballs available at [the original Ronn repo](http://github.com/rtomayko/ronn/downloads).
|
95
|
+
This is the originall Ronn project that Ronn-NG was forked from.
|
94
96
|
|
95
|
-
```
|
97
|
+
```brew
|
96
98
|
curl -L http://github.com/rtomayko/ronn/downloads/0.6.6 | tar xvzf -
|
97
99
|
cd rtomayko-r*
|
98
100
|
ruby setup.rb
|
data/LICENSE.txt
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
The MIT License
|
2
2
|
|
3
3
|
Copyright (C) 2009 Ryan Tomayko <tomayko.com/about>
|
4
|
-
Copyright (C) 2018, 2019 Andrew Janke <apjanke.net>
|
4
|
+
Copyright (C) 2018, 2019, 2020, 2022 Andrew Janke <apjanke.net>
|
5
5
|
|
6
6
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
7
7
|
|
data/README.md
CHANGED
@@ -15,14 +15,14 @@ The `*.ronn` files found in the [`man/`][1] directory show off a wide range of
|
|
15
15
|
ronn capabilities:
|
16
16
|
|
17
17
|
* [ronn(1)](http://rtomayko.github.com/ronn/ronn.1) command -
|
18
|
-
[source file](http://github.com/apjanke/ronn-ng/blob/
|
19
|
-
[roff output](http://github.com/apjanke/ronn-ng/blob/
|
18
|
+
[source file](http://github.com/apjanke/ronn-ng/blob/main/man/ronn.1.ronn),
|
19
|
+
[roff output](http://github.com/apjanke/ronn-ng/blob/main/man/ronn.1)
|
20
20
|
|
21
21
|
* [ronn-format(7)](http://rtomayko.github.com/ronn/ronn-format.7) -
|
22
|
-
[source file](http://github.com/apjanke/ronn-ng/blob/
|
23
|
-
[roff output](http://github.com/apjanke/ronn-ng/blob/
|
22
|
+
[source file](http://github.com/apjanke/ronn-ng/blob/main/man/ronn-format.7.ronn),
|
23
|
+
[roff output](http://github.com/apjanke/ronn-ng/blob/main/man/ronn-format.7)
|
24
24
|
|
25
|
-
[1]: http://github.com/apjanke/ronn-ng/tree/
|
25
|
+
[1]: http://github.com/apjanke/ronn-ng/tree/main/man
|
26
26
|
|
27
27
|
As an alternative, you might want to check out [pandoc](http://johnmacfarlane.net/pandoc/) which can also convert markdown into roff manual pages.
|
28
28
|
|
@@ -83,7 +83,7 @@ comprehensive documentation on `ronn` command line options.
|
|
83
83
|
|
84
84
|
## Background
|
85
85
|
|
86
|
-
Some think Unix
|
86
|
+
Some think Unix man pages are a poor and outdated form of documentation. Ronn-NG
|
87
87
|
disagrees:
|
88
88
|
|
89
89
|
* Manpages follow a well defined structure that's immediately familiar. This
|
@@ -120,7 +120,13 @@ modern publishing tools. Ronn aims to solve that problem.
|
|
120
120
|
|
121
121
|
## Requirements
|
122
122
|
|
123
|
-
Ruby 2.
|
123
|
+
Ronn-NG requires Ruby 2.4 or newer.
|
124
|
+
|
125
|
+
Ruby 3.x support is a work in progress as of Ronn-NG 0.10.1 (December 2022).
|
126
|
+
|
127
|
+
If you are installing Ronn-NG as a standalone program (the usual way to use it), it
|
128
|
+
includes all its Ruby libraries, and has no other dependencies. If you are using
|
129
|
+
Ronn-NG as a gem or other library, it requires gems as listed in `ronn-ng.gemspec`.
|
124
130
|
|
125
131
|
## Project Management
|
126
132
|
|
@@ -137,10 +143,10 @@ MIT License.
|
|
137
143
|
|
138
144
|
Ronn is Copyright (C) 2010 [Ryan Tomayko](http://tomayko.com/about).
|
139
145
|
|
140
|
-
New Ronn-NG material is Copyright (C) 2018-
|
146
|
+
New Ronn-NG material is Copyright (C) 2018-2022 [Andrew Janke](https://apjanke.net) and other contributors.
|
141
147
|
|
142
148
|
See the file LICENSE.txt for information of licensing and distribution.
|
143
149
|
|
144
150
|
## Build Status
|
145
151
|
|
146
|
-
![Travis build status](https://travis-ci.com/apjanke/ronn-ng.svg?branch=
|
152
|
+
![Travis build status](https://travis-ci.com/apjanke/ronn-ng.svg?branch=main)
|
data/Rakefile
CHANGED
@@ -69,7 +69,7 @@ end
|
|
69
69
|
task :rev do
|
70
70
|
rev = ENV['REV'] || `git describe --tags`.chomp
|
71
71
|
data = File.read('lib/ronn.rb')
|
72
|
-
data.gsub!(/^( *)REV *=.*/, "\\1REV = '#{rev}'")
|
72
|
+
data.gsub!(/^( *)REV *=.*/, "\\1REV = '#{rev.sub(/\Av/, '')}'.freeze")
|
73
73
|
File.open('lib/ronn.rb', 'wb') { |fd| fd.write(data) }
|
74
74
|
puts "revision: #{rev}"
|
75
75
|
puts "version: #{`ruby -Ilib -rronn -e 'puts Ronn::VERSION'`}"
|
data/bin/ronn
CHANGED
data/lib/ronn/document.rb
CHANGED
@@ -179,11 +179,14 @@ module Ronn
|
|
179
179
|
end
|
180
180
|
|
181
181
|
# The date the man page was published. If not set explicitly,
|
182
|
-
#
|
182
|
+
# it first checks for "SOURCE_DATE_EPOCH" to support reproducible
|
183
|
+
# builds, then the file's modified time or, if no file is given,
|
183
184
|
# the current time. Center displayed in the document footer.
|
184
185
|
def date
|
185
186
|
return @date if @date
|
186
187
|
|
188
|
+
return Time.at(ENV['SOURCE_DATE_EPOCH'].to_i).gmtime if ENV['SOURCE_DATE_EPOCH']
|
189
|
+
|
187
190
|
return File.mtime(path) if File.exist?(path)
|
188
191
|
|
189
192
|
Time.now
|
data/lib/ronn/roff.rb
CHANGED
@@ -111,6 +111,10 @@ module Ronn
|
|
111
111
|
macro 'SH', quote(escape(node.inner_html))
|
112
112
|
when 'h3'
|
113
113
|
macro 'SS', quote(escape(node.inner_html))
|
114
|
+
when 'h4', 'h5', 'h6'
|
115
|
+
# Ronn discourages use of this many heading levels, but if they are used,
|
116
|
+
# we should make them legible instead of ignoring them.
|
117
|
+
macro 'SS', quote(escape(node.inner_html))
|
114
118
|
|
115
119
|
when 'p'
|
116
120
|
prev = previous(node)
|
@@ -1,7 +1,7 @@
|
|
1
1
|
<!DOCTYPE html>
|
2
2
|
<html>
|
3
3
|
<head>
|
4
|
-
<meta http-equiv='content-type' content='text/html;charset=
|
4
|
+
<meta http-equiv='content-type' content='text/html;charset=utf-8'>
|
5
5
|
<meta name='generator' content='{{ generator }}'>
|
6
6
|
<title>{{ title }}</title>
|
7
7
|
{{{ stylesheet_tags }}}
|
data/lib/ronn.rb
CHANGED
@@ -22,15 +22,15 @@ module Ronn
|
|
22
22
|
|
23
23
|
# A semantic version number based on the git revision. The third element
|
24
24
|
# of the version is incremented by the commit offset, such that version
|
25
|
-
#
|
25
|
+
# v0.6.6-5-gdacd74b => 0.6.11
|
26
26
|
def self.version
|
27
|
-
ver = revision[/^[0-9.-]+/].split(/[.-]/).map(&:to_i)
|
27
|
+
ver = revision.sub(/\Av/, '')[/^[0-9.-]+/].split(/[.-]/).map(&:to_i)
|
28
28
|
ver[2] += ver.pop while ver.size > 3
|
29
29
|
ver.join('.')
|
30
30
|
end
|
31
31
|
|
32
32
|
# The string revision as reported by: git-describe --tags. This is just the
|
33
|
-
# tag name when a tag references the HEAD commit (e.g.
|
33
|
+
# tag name when a tag references the HEAD commit (e.g. v0.6.25). When the HEAD
|
34
34
|
# commit is not tagged, this is a "<tag>-<offset>-<sha1>" string:
|
35
35
|
# <tag> - closest tag name
|
36
36
|
# <offset> - number of commits ahead of <tag>
|
@@ -40,8 +40,6 @@ module Ronn
|
|
40
40
|
end
|
41
41
|
|
42
42
|
# value generated by: rake rev
|
43
|
-
|
44
|
-
# tags -apjanke
|
45
|
-
REV = '0.10.1.pre1'.freeze
|
43
|
+
REV = '0.10.1.pre3'.freeze
|
46
44
|
VERSION = version
|
47
45
|
end
|
data/man/index.html
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
<!DOCTYPE html>
|
2
2
|
<html>
|
3
3
|
<head>
|
4
|
-
<title>Ronn</title>
|
4
|
+
<title>Ronn-NG</title>
|
5
5
|
<style>
|
6
6
|
body {
|
7
7
|
font-size:24px;
|
@@ -41,16 +41,16 @@
|
|
41
41
|
</head>
|
42
42
|
<body>
|
43
43
|
<div id='index'>
|
44
|
-
<h1>Ronn</h1>
|
44
|
+
<h1>Ronn-NG</h1>
|
45
45
|
<h3>Builds manuals</h3>
|
46
46
|
|
47
47
|
<h4>Auxiliary</h4>
|
48
48
|
<p class='aux'>
|
49
|
-
<a href='
|
50
|
-
<a href='
|
51
|
-
<a href='
|
52
|
-
<a href='
|
53
|
-
<a href='
|
49
|
+
<a href='https://github.com/apjanke/ronn-ng#readme'>README</a>,
|
50
|
+
<a href='https://github.com/apjanke/ronn-ng/blob/main/INSTALLING.md'>INSTALLING</a>,
|
51
|
+
<a href='https://github.com/apjanke/ronn-ng/blob/main/CHANGES'>CHANGES</a>,
|
52
|
+
<a href='https://github.com/apjanke/ronn-ng/blob/main/LICENSE.txt'>LICENSE</a>,
|
53
|
+
<a href='https://github.com/apjanke/ronn-ng/blob/main/AUTHORS'>AUTHORS</a>
|
54
54
|
</p>
|
55
55
|
|
56
56
|
<h4>Manuals</h4>
|
@@ -64,15 +64,16 @@
|
|
64
64
|
|
65
65
|
<h4>See Also</h4>
|
66
66
|
<p class='also'>
|
67
|
-
<a class='man-ref' href="
|
68
|
-
<a class='man-ref' href="
|
69
|
-
<a class='man-ref' href="
|
70
|
-
<a class='man-ref' href="
|
71
|
-
<a class='man-ref' href="
|
72
|
-
<a class='man-ref' href="
|
67
|
+
<a class='man-ref' href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man5/manpages.5.html">manpages(5)</a>,
|
68
|
+
<a class='man-ref' href="https://daringfireball.net/projects/markdown/syntax">markdown(7)</a>,
|
69
|
+
<a class='man-ref' href="https://man7.org/linux/man-pages/man1/man.1.html">man(1)</a>,
|
70
|
+
<a class='man-ref' href="https://man7.org/linux/man-pages/man7/roff.7.html">roff(7)</a>,
|
71
|
+
<a class='man-ref' href="https://man7.org/linux/man-pages/man1/groff.1.html">groff(1)</a>,
|
72
|
+
<a class='man-ref' href="https://mustache.github.io/mustache.5.html">mustache(5)</a>,
|
73
|
+
<a class='man-ref' href="https://linux.die.net/man/1/pandoc">pandoc(1)</a>
|
73
74
|
</p>
|
74
75
|
|
75
|
-
<p class='copy'>Copyright © 2010 Ryan Tomayko, © 2018 Andrew Janke</p>
|
76
|
+
<p class='copy'>Copyright © 2010 Ryan Tomayko, © 2018, 2019, 2020, 2022, 2023 Andrew Janke, © 2022 Takuya Noguchi</p>
|
76
77
|
</div>
|
77
78
|
</body>
|
78
79
|
</html>
|
data/man/index.txt
CHANGED
@@ -4,12 +4,13 @@ ronn(5) ronn.5.ronn
|
|
4
4
|
ronn(7) ronn.7.ronn
|
5
5
|
|
6
6
|
# external manuals
|
7
|
-
roff(7)
|
8
|
-
grep(1)
|
9
|
-
groff(1)
|
10
|
-
sh(1)
|
11
|
-
test(1)
|
12
|
-
fork(2)
|
13
|
-
man(1)
|
14
|
-
markdown(7)
|
15
|
-
manpages(5)
|
7
|
+
roff(7) https://man7.org/linux/man-pages/man7/roff.7.html
|
8
|
+
grep(1) https://man7.org/linux/man-pages/man1/grep.1.html
|
9
|
+
groff(1) https://man7.org/linux/man-pages/man1/groff.1.html
|
10
|
+
sh(1) https://man7.org/linux/man-pages/man1/sh.1p.html
|
11
|
+
test(1) https://man7.org/linux/man-pages/man1/test.1.html
|
12
|
+
fork(2) https://man7.org/linux/man-pages/man2/fork.2.html
|
13
|
+
man(1) https://man7.org/linux/man-pages/man1/man.1.html
|
14
|
+
markdown(7) https://daringfireball.net/projects/markdown/syntax
|
15
|
+
manpages(5) https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man5/manpages.5.html
|
16
|
+
pandoc(1) https://linux.die.net/man/1/pandoc
|
data/man/ronn-format.7
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
.\" generated with Ronn-NG/v0.10.1
|
2
|
-
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1.
|
3
|
-
.TH "RONN\-FORMAT" "7" "December
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1.pre3
|
3
|
+
.TH "RONN\-FORMAT" "7" "December 2022" "Ronn-NG 0.10.1.pre3" "Ronn Manual"
|
4
4
|
.SH "NAME"
|
5
5
|
\fBronn\-format\fR \- manual authoring format based on Markdown
|
6
6
|
.SH "SYNOPSIS"
|
data/man/ronn.1
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
.\" generated with Ronn-NG/v0.10.1
|
2
|
-
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1.
|
3
|
-
.TH "RONN" "1" "January
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1.pre3
|
3
|
+
.TH "RONN" "1" "January 2023" "Ronn-NG 0.10.1.pre3" "Ronn Manual"
|
4
4
|
.SH "NAME"
|
5
5
|
\fBronn\fR \- convert markdown files to manpages
|
6
6
|
.SH "SYNOPSIS"
|
@@ -31,23 +31,28 @@ Source files must be in UTF\-8 encoding, or the encoding specified by the \fB\-E
|
|
31
31
|
When building roff or HTML output files, destination filenames are determined by taking the basename of the input \fIfile\fR and adding the appropriate file extension (or removing the file extension in the case of roff output)\. For example, executing \fBronn example\.1\.ronn\fR generates \fBexample\.1\fR with roff output and \fBexample\.1\.html\fR with HTML output\.
|
32
32
|
.SH "OPTIONS"
|
33
33
|
These options control whether output is written to file(s), standard output, or directly to a man pager\.
|
34
|
-
.
|
35
|
-
\fB\-m\fR, \fB\-\-man\fR
|
36
|
-
|
37
|
-
|
34
|
+
.TP
|
35
|
+
\fB\-m\fR, \fB\-\-man\fR
|
36
|
+
Don't generate files, display \fIfile\fRs as if man(1) were invoked on the roff output file\. This simulates default man behavior by piping the roff output through groff(1) and the paging program specified by the \fBMANPAGER\fR environment variable\.
|
37
|
+
.TP
|
38
|
+
\fB\-S\fR, \fB\-\-server\fR
|
39
|
+
Don't generate files, start an HTTP server at \fIhttp://localhost:1207/\fR and serve dynamically generated HTML for the set of input \fIfile\fRs\. A file named \fIexample\.2\.ronn\fR is served as \fI/example\.2\.html\fR\. There's also an index page at the root with links to each \fIfile\fR\.
|
38
40
|
.IP
|
39
41
|
The server respects the \fB\-\-style\fR and document attribute options (\fB\-\-manual\fR, \fB\-\-date\fR, etc\.)\. These same options can be varied at request time by giving them as query parameters: \fB?manual=FOO&style=dark,toc\fR
|
40
42
|
.IP
|
41
43
|
\fINOTE: The builtin server is designed to assist in the process of writing and styling manuals\. It is in no way recommended as a general purpose web server\.\fR
|
42
|
-
.
|
43
|
-
\fB\-\-port\fR=\fIport\fR
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
.
|
49
|
-
\fB\-
|
50
|
-
|
44
|
+
.TP
|
45
|
+
\fB\-\-port\fR=\fIport\fR
|
46
|
+
When used with \fB\-S\fR/\fB\-\-server\fR, runs the server at the specified port instead of the default port 1207\.
|
47
|
+
.TP
|
48
|
+
\fB\-\-pipe\fR
|
49
|
+
Don't generate files, write generated output to standard output\. This is the default behavior when ronn source text is piped in on standard input and no \fIfile\fR arguments are provided\.
|
50
|
+
.TP
|
51
|
+
\fB\-o\fR=\fIdirectory\fR, \fB\-\-output\-dir\fR=\fIdirectory\fR
|
52
|
+
Write generated files to the specified directory instead of the default location\.
|
53
|
+
.TP
|
54
|
+
\fB\-E\fR=\fIencoding\fR, \fB\-\-encoding\fR=\fIencoding\fR
|
55
|
+
Specify the encoding that input files are in\. Default is UTF\-8, regardless of user's locale settings\. Input sent to STDIN is always treated as UTF\-8, regardless of whether \fB\-E\fR is passed\.
|
51
56
|
.P
|
52
57
|
Format options control the files \fBronn\fR generates, or the output format when the \fB\-\-pipe\fR argument is specified\. When no format options are given, both \fB\-\-roff\fR and \fB\-\-html\fR are assumed\.
|
53
58
|
.TP
|
@@ -101,11 +106,11 @@ whisky(1) whisky\.1\.ronn
|
|
101
106
|
tango(5) tango\.5\.ronn
|
102
107
|
|
103
108
|
# external manuals
|
104
|
-
grep(1)
|
105
|
-
ls(1)
|
109
|
+
grep(1) https://man7\.org/linux/man\-pages/man1/grep\.1\.html
|
110
|
+
ls(1) https://man7\.org/linux/man\-pages/man1/ls\.1\.html
|
106
111
|
|
107
112
|
# other URLs for use with markdown reference links
|
108
|
-
src
|
113
|
+
src https://github\.com/
|
109
114
|
.fi
|
110
115
|
.IP "" 0
|
111
116
|
.P
|
@@ -149,7 +154,7 @@ The heading and footing, respectively\.
|
|
149
154
|
\fB\.man\-title\fR
|
150
155
|
The main \fB<h1>\fR element\. Hidden by default unless the manual has no \fIname\fR or \fIsection\fR attributes\.
|
151
156
|
.P
|
152
|
-
See the builtin style sources \
|
157
|
+
See the builtin style sources \fIhttps://github\.com/apjanke/ronn\-ng/tree/main/lib/ronn/template\fR for examples\.
|
153
158
|
.SH "EXAMPLES"
|
154
159
|
Build roff and HTML output files and view the roff manpage using man(1):
|
155
160
|
.IP "" 4
|
@@ -222,6 +227,6 @@ The paging program used for man pages\. This is typically set to something like
|
|
222
227
|
\fBPAGER\fR
|
223
228
|
Used instead of \fBMANPAGER\fR when \fBMANPAGER\fR is not defined\.
|
224
229
|
.SH "COPYRIGHT"
|
225
|
-
Ronn\-NG is Copyright (C) 2009 Ryan Tomayko \
|
230
|
+
Ronn\-NG is Copyright (C) 2009 Ryan Tomayko \fIhttps://tomayko\.com/about\fR, (C) 2018\-2023 Andrew Janke \fIhttps://apjanke\.net\fR, and other contributors\. See the AUTHORS file in the Ronn\-NG distribution for full details\.
|
226
231
|
.SH "SEE ALSO"
|
227
232
|
groff(1), man(1), pandoc(1), manpages(5), markdown(7), roff(7), ronn\-format(7)
|
data/man/ronn.1.ronn
CHANGED
@@ -70,7 +70,7 @@ directly to a man pager.
|
|
70
70
|
and styling manuals. It is in no way recommended as a general purpose web
|
71
71
|
server.*
|
72
72
|
|
73
|
-
* `--port`=<port
|
73
|
+
* `--port`=<port>:
|
74
74
|
When used with `-S`/`--server`, runs the server at the specified port instead
|
75
75
|
of the default port 1207.
|
76
76
|
|
@@ -83,7 +83,7 @@ directly to a man pager.
|
|
83
83
|
Write generated files to the specified directory instead of the default
|
84
84
|
location.
|
85
85
|
|
86
|
-
* `-E`=<encoding>, `--encoding`=<encoding
|
86
|
+
* `-E`=<encoding>, `--encoding`=<encoding>:
|
87
87
|
Specify the encoding that input files are in. Default is UTF-8, regardless
|
88
88
|
of user's locale settings. Input sent to STDIN is always treated as UTF-8,
|
89
89
|
regardless of whether `-E` is passed.
|
@@ -164,11 +164,11 @@ ignored:
|
|
164
164
|
tango(5) tango.5.ronn
|
165
165
|
|
166
166
|
# external manuals
|
167
|
-
grep(1)
|
168
|
-
ls(1)
|
167
|
+
grep(1) https://man7.org/linux/man-pages/man1/grep.1.html
|
168
|
+
ls(1) https://man7.org/linux/man-pages/man1/ls.1.html
|
169
169
|
|
170
170
|
# other URLs for use with markdown reference links
|
171
|
-
src
|
171
|
+
src https://github.com/
|
172
172
|
|
173
173
|
The <location> is an absolute or relative URL that usually points at an HTML
|
174
174
|
version of manpage. It's possible to define references for things that aren't
|
@@ -237,7 +237,7 @@ allow targeting all generated elements:
|
|
237
237
|
|
238
238
|
See the [builtin style sources][builtin] for examples.
|
239
239
|
|
240
|
-
[builtin]:
|
240
|
+
[builtin]: https://github.com/apjanke/ronn-ng/tree/main/lib/ronn/template
|
241
241
|
"Builtin Stylesheet .css files"
|
242
242
|
|
243
243
|
## EXAMPLES
|
@@ -309,8 +309,9 @@ under a `man/` directory:
|
|
309
309
|
|
310
310
|
## COPYRIGHT
|
311
311
|
|
312
|
-
Ronn-NG is Copyright (C) 2009 Ryan Tomayko <
|
313
|
-
(C) 2018 Andrew Janke <https://apjanke.net
|
312
|
+
Ronn-NG is Copyright (C) 2009 Ryan Tomayko <https://tomayko.com/about>,
|
313
|
+
(C) 2018-2023 Andrew Janke <https://apjanke.net>, and other contributors.
|
314
|
+
See the AUTHORS file in the Ronn-NG distribution for full details.
|
314
315
|
|
315
316
|
## SEE ALSO
|
316
317
|
|