The officially official Devuan Forum!

igorzwx

Member

Registered: 2024-05-06

Posts: 422  

[HowTo] Markdown (ronn) to man

ronn is a Markdown-like format for writing man pages. It's readable and editable in any text editor.

To enable syntax highlighting for .ronn files in VSCodium:

1. Open the .ronn file.

2. Click on "Plain Text" in the bottom-right corner of the status bar.

3. Select "Markdown" from the language list.

This applies Markdown highlighting, which works well for .ronn files.
Alternatively, use the command palette: 
Ctrl+Shift+P → "Change Language Mode" → "Markdown".

To convert .ronn files to man format, use the ronn utility available in Devuan repositories:

$ apt-cache search ronn$
ronn - tool to build manuals from Markdown
ruby-ronn - library to build manuals from Markdown

Install ronn:

sudo apt install ronn

Convert .ronn file to man format:

ronn --roff pcm_conv.1.ronn

This generates pcm_conv.1.
View the man page:

man ./pcm_conv.1

Example .ronn file:

cat pcm_conv.1.ronn

PCM_CONV(1)                                         User Commands                                         PCM_CONV(1)

## NAME

pcm_conv - high-quality FFT/DCT-based audio resampler

## SYNOPSIS

`pcm_conv` [<input_file>] [<output_file>] [ `-c` <number> ] [ `-m` <mask> ] [ `-n` <on>`|`<off> ] [ `-I` <input_order> ] [ `-O` <output_order> ] [ `-b` <bits> ] [ `-f` <frequency> ] [ `-T` <trans> ] [ `-W` <win> ] [ `-v` ] [ `-h | --help | --help-all` ]

## DESCRIPTION

Converts WAVE files with high-quality sample rate conversion using FFT or DCT transforms.

## OPTIONS

`-c`
:    Number of output channels: 1 (mono), 2 (stereo), up to 6 (3/2+SW).

`-m`
:    Channel mask (may conflict with -c).

`-n`
:    Normalize channel matrix (default: on).

`-I` <order>, `-O` <order>
:    Input/output channel order: MS, ALSA, or OSS layout.

`-b` <bits>
:    Output bit depth: 8, 16, 24, 32, 32f, or 64f.

`-f` <value of sample rate in Hz>, e.g.: `-f` 192000  
:    Output sample rate. The range of 6000–192000 Hz is 100% reliable. Rates above 192 kHz (e.g., 1411200 Hz) appear reliable based on testing, but require further validation with `pcm_mse`.     

`-T` <dct>`|`<fft>
:    Transform type (default: dct).

`-W` <vorbis>`|`<hanning>`|`<rect>
:    Windowing function (default: vorbis).

`-v`
:    Verbose output.

`--help-all`
:    Show full help.

## FILES

/etc/fftrate.conf
:    System-wide configuration.

~/.asoundrc
:    User ALSA configuration (used by fftrate plugin).

## SEE ALSO

arateconf(1), fftrate(7)

## EXAMPLES

Convert a 32-bit WAV file to 192kHz, 32-bit fixed-point using FFT resampling:

    $ pcm_conv -f 192000 -b 32 -T fft -v *32bit.wav Faust_192kHz_32bit_downfft.wav
    Input file : 08-Faust - Funeral March Of A Marionette - 32bit.wav
     Samples rate    = 352800 Hz
     Channels        = 2
     Bits per sample = 32 (actual: 32, float)

    Output file: Faust_192kHz_32bit_downfft.wav
     Samples rate    = 192000 Hz
     Channels        = 2
     Bits per sample = 32 (actual: 32, fixed)

            FL      FR      
    FL      1.000   -----   
    FR      -----   1.000   

    Windows : "Vorbis" (37632 => 20480)
    Delay   : 107 ms
    Sync.   : ON
    Trans.  : "FFT"

    [|||||||||||||||||||||||||||||||||||||||||||||||||||]  99.0 %
    Ok.

    File duration  : 275.906667 sec
    Processing time: 13.305000 sec ( 4.82% of real time)   

## VERSION

1.6.3

## DATE

November 2025

Manual:

man ronn-format

_https://rtomayko.github.io/ronn/ronn-format.7.html

Last edited by igorzwx (2025-12-05 11:05:53)

ralph.ronnquist

Administrator

From: Battery Point, Tasmania, AUS

Registered: 2016-11-30

Posts: 1,551  

Re: [HowTo] Markdown (ronn) to man

I prefer asciidoctor

EDX-0

Member

Registered: 2020-12-12

Posts: 186  

Re: [HowTo] Markdown (ronn) to man

but where is the fun of writing manpages by hand and having formatting not work cuz you typed one extra char after the macro?

greenjeans

Member

Registered: 2017-04-07

Posts: 1,340  

Website

Re: [HowTo] Markdown (ronn) to man

wait...you guys are adding man pages to stuff?

---

https://sourceforge.net/projects/vuu-do/ New Vuu-do isos uploaded October 2025!
Vuu-do GNU/Linux, minimal Devuan-based Openbox and Mate systems to build on. Also a max version for OB.
Devuan 5 mate-mini iso, pure Devuan, 100% no-vuu-do. Devuan 6 version also available for testing.
Please donate to support Devuan and init freedom! https://devuan.org/os/donate

EDX-0

Member

Registered: 2020-12-12

Posts: 186  

Re: [HowTo] Markdown (ronn) to man

i have hand written manpages by hand for scripts that aren't even 500 lines of code long and that is because i have not generalized redundant code into functions enough like for this systemact script https://github.com/eylles/systemact which as far as i know i'm the only user and i don't even use like half of the features i've added...