shell-novice icon indicating copy to clipboard operation
shell-novice copied to clipboard

man command in 02-filedir.md

Open matuskalas opened this issue 2 years ago • 3 comments

man is not available on Windows (in Git Bash).

Section https://swcarpentry.github.io/shell-novice/02-filedir/index.html#getting-help states that very nicely and shows the options.

However, a bit below the section https://swcarpentry.github.io/shell-novice/02-filedir/index.html#the-man-command is about the man command again, not mentioning that it doesn't work in Git Bash/Windows, and not providing another option. (Additionally, perhaps these 2 sections are to some extent duplicating each other?)

matuskalas avatar Dec 05 '22 09:12 matuskalas

The sections below have more detailed explanations for both --help and man. Do you have suggestions for improvements? People on Windows may connect to a remote system which uses Linux, or use Windows Subsystem for Linux, so it is helpful to have some information on man.

bkmgit avatar Dec 05 '22 12:12 bkmgit

The sections below have more detailed explanations for both --help and man. Do you have suggestions for improvements? People on Windows may connect to a remote system which uses Linux, or use Windows Subsystem for Linux, so it is helpful to have some information on man.

It definitely is useful! 👍🏽 And on Mac, --help does not work. So I really like the section getting help, and I'd suggest to merge the slightly later section man command into it, while making it also describing --help.

matuskalas avatar Dec 05 '22 19:12 matuskalas

@matuskalas Some workarounds are mentioned in #249.

If you have control of the environment your students are using, it's theoretically possible to pre-install the man command and some of the basic man pages, using the command mentioned in this comment. But if you don't, it's probably beyond the scope of an afternoon workshop, for the students to try and install that stuff themselves.

ernstki avatar Jan 20 '23 08:01 ernstki