Should there be a manpage for `gsh`?

[phyver]

Should there be a manpage for `gsh`?

[phyver]

I'd prefer keeping gsh help, but a manpage could replace gsh HELP.

[rlepigre]

Sounds like an easy enough thing to add!
We could even think about replacing gsh help by man gsh (not sure that is a good idea though).

[rlepigre]

Indeed, good idea!

[Aierbote]

Maybe it's a bit off topic, but I was wondering what was the difference between gsh help and gsh HELP

I hope there will be soon a man gsh, becasue I've already checked it on my own before reading this.

[rlepigre]

Both gsh help and gsh HELP show you a list of available commands of the form gsh <command>. The difference is that gsh help lists commands that are useful to play the game, while gsh HELP lists all available commands. Some commands are not intended to be used by the player, for example commands that skip a mission (it can be used in a teaching context when a student is stuck for too long, or when there is a bug in a mission that makes it unsolvable) or that are useful for debugging.

[phyver]

What would you put in the man page?
. The equivalent of gsh help,
. the equivalent of gsh HELP,
. the equivalent of bash gameshell.sh -h,
. all of the above?

Putting everything makes sense, but for newcomers, that will be too long.

The output of ./gameshell.sh -h doesn't really make sense on its own, as this man page will only be accessible from inside GameShell, when you're not supposed to run another version of GameShell.

Maybe just the equivalent of gsh help, with the addition of a description of gsh HELP?

[rlepigre]

Maybe we want more than one man page? One that is intended for users (accessed with man gsh and containing roughly the same thing as gsh help), and one that is more complete (accessed with man gsh-commands or something similar).

[rlepigre]

But in all cases, we want to share as much text as possible to avoid too much duplication when translating the game.