Setup groff (GNU roff)

This action sets up groff (GNU roff).

Prerequisites

OS	Supported	Tools
Linux	✅	None
macOS	✅	brew
Windows	❌	N/A

Inputs

- uses: fabasoad/setup-groff-action@v0
  with:
    # (Optional) If "true" it installs groff even if it is already installed on
    # a runner. Otherwise, skips installation. Defaults to "false".
    force: "false"

Outputs

Name	Description	Example
installed	Whether groff was installed or not	true

Example

Let's try to run hello-world.roff file using the workflow below.

name: Setup groff

on: push

jobs:
  setup:
    name: Setup
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: fabasoad/setup-groff-action@v0
      - run: groff -man -Tascii hello.roff

And you should see the following output:

HELLO(1)                    General Commands Manual                   HELLO(1)

NAME
       hello - print Hello, World!

SYNOPSIS
       hello

DESCRIPTION
       The hello command prints "Hello, World!" to the standard output.

EXAMPLES
       hello

       Hello, World!


Hello Manual                       June 2024                          HELLO(1)

Contributions