[GH-ISSUE #1225] Unify help and man page #657

New issue

Open

opened 2026-03-04 01:47:36 +03:00 by kerem · 1 comment

kerem commented

2026-03-04 01:47:36 +03:00

Owner

Originally created by @gaul on GitHub (Jan 5, 2020).
Original GitHub issue: https://github.com/s3fs-fuse/s3fs-fuse/issues/1225

src/s3fs_util.cpp and doc/man/s3fs.1 become desynchronized when contributors edit one but not the other. Can we unify these somehow? ronn generates man pages from Markdown; perhaps we can generate plain text from the Markdown and include it in src/s3fs_util.cpp?

Originally created by @gaul on GitHub (Jan 5, 2020). Original GitHub issue: https://github.com/s3fs-fuse/s3fs-fuse/issues/1225 `src/s3fs_util.cpp` and `doc/man/s3fs.1` become desynchronized when contributors edit one but not the other. Can we unify these somehow? [ronn](https://github.com/rtomayko/ronn) generates man pages from Markdown; perhaps we can generate plain text from the Markdown and include it in `src/s3fs_util.cpp`?

kerem added the

enhancement

label

2026-03-04 01:47:36 +03:00

kerem commented

2026-03-04 01:47:37 +03:00

Author

Owner

@gaul commented on GitHub (Feb 12, 2021):

help2man can do this although the output does not look good due to the way s3fs formats its --help.

@gaul commented on GitHub (Feb 12, 2021): [help2man](https://linux.die.net/man/1/help2man) can do this although the output does not look good due to the way s3fs formats its `--help`.