Merge pull request #587 from peco/gh-467

Add man page. fixes #467
This commit is contained in:
lestrrat 2026-02-15 16:56:01 +09:00 committed by GitHub
commit 46ecbd1e57
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 1695 additions and 0 deletions

25
.github/workflows/manpage.yml vendored Normal file
View file

@ -0,0 +1,25 @@
name: Update man page
on:
push:
branches: [master]
paths: ['README.md']
jobs:
update-manpage:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- name: Install pandoc
run: sudo apt-get update && sudo apt-get install -y pandoc
- name: Generate man page
run: bash contrib/man/generate.sh
- name: Create Pull Request
uses: peter-evans/create-pull-request@22a9089034f40e5a961c8808d113e2c98fb63676 # v7
with:
commit-message: "docs: regenerate man page from README"
title: "docs: update man page"
body: |
Auto-generated update to `contrib/man/peco.1` from changes to `README.md`.
branch: update-manpage
delete-branch: true

10
contrib/man/generate.sh Executable file
View file

@ -0,0 +1,10 @@
#!/bin/sh
set -e
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
REPO_ROOT="$(cd "$SCRIPT_DIR/../.." && pwd)"
pandoc -s -f markdown -t man \
-V title=PECO -V section=1 \
-V header="User Commands" \
-V footer="peco" \
-o "$SCRIPT_DIR/peco.1" \
"$REPO_ROOT/README.md"

1660
contrib/man/peco.1 Normal file

File diff suppressed because it is too large Load diff