Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Making proper manpage from README.md #22

Open
KAction opened this issue Feb 27, 2021 · 1 comment
Open

Making proper manpage from README.md #22

KAction opened this issue Feb 27, 2021 · 1 comment

Comments

@KAction
Copy link

KAction commented Feb 27, 2021

Hello.

README.md is written in style of manual pages, but when I use pandoc to make manpage, result is not exactly what I want: extra indentation on the left and missing manpage name in left corner. I came with following script to fix that:

    cat << EOF > manpage.md
    ---
    title: vidir(1)
    ---
    EOF
    sed 's/    //' < README.md \
      | awk '{ print } /^# / { print "\n"; }' >> manpage.md
    pandoc -s manpage.md -o vidir.1

Unless you have another tool to generate manpage in mind, what about we apply this transformation and commit?

Also, it looks like both bin/vidir and README.md contain manpage content, and it takes some time to figure out that README.md is actually more up-to-date. What about if we remove extra copy?

@agvxov
Copy link

agvxov commented Jan 18, 2024

The reason the README.md looks very similar to a man page is because it was made from a man page: https://linux.die.net/man/1/vidir

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants