Repository navigation
Should there be a manpage for gsh? #40
Description
Activity
Sounds like an easy enough thing to add!
We could even think about replacinggsh helpbyman gsh(not sure that is a good idea though).I'd prefer keeping
gsh help, but a manpage could replacegsh HELP.Reacted by Alberto CangialosiIndeed, good idea!
Maybe it's a bit off topic, but I was wondering what was the difference between
gsh helpandgsh HELPI hope there will be soon a
man gsh, becasue I've already checked it on my own before reading this.Both
gsh helpandgsh HELPshow you a list of available commands of the formgsh <command>. The difference is thatgsh helplists commands that are useful to play the game, whilegsh HELPlists 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.What would you put in the man page?
. The equivalent ofgsh help,
. the equivalent ofgsh HELP,
. the equivalent ofbash gameshell.sh -h,
. all of the above?Putting everything makes sense, but for newcomers, that will be too long.
The output of
./gameshell.sh -hdoesn'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 ofgsh HELP?Maybe we want more than one man page? One that is intended for users (accessed with
man gshand containing roughly the same thing asgsh help), and one that is more complete (accessed withman gsh-commandsor something similar).But in all cases, we want to share as much text as possible to avoid too much duplication when translating the game.
@rlepigre, @Mte90 and anyone reading this...
I just pushed some commits on the devel branch with a first version of a manpage for
gsh, generated with asciidoc. It mostly contains the same information as thegsh HELPcommand but tries to follow standard manpage style.I would welcome any remark, comment, criticism, idea or suggestion about it.
If you pull the devel branch, you can simply run
$ man ./man/man1/gsh.1from the root of the repository. (Note that I regularly force-push on this branch!)
The output of
gsh HELPis generated at the same time and can be found in the files/i18n/gsh-full-help /{en,fr}.txt. (The Italian version is, hasn't changed at this time...)There also is a manpage for
gameshell.sh, but that's not very relevant for a player inside a GameShell session. It is intended to replace thedoc/gameshell.mdfile at some point... A pure text version is also in./i18n/source/gameshell/en.txt.Can you just ping when it is time to localize as it is finished?
@phyver I had a look and this looks pretty good. I have not read the full contents really carefully, so there might be typos. Actually I just remembered one: "where it was left of" should be "where it was left off" I believe. I like the idea of using a manpage for
gameshell.shto replacedoc/gameshell.md(or at least generate both from the same sources).
It could be installed somewhere and
MANPATHbe updated.(POSIX specifically mentions this variable is not standardized but that many system use it...)