phatina / simple-mtpfs

Simple MTP fuse filesystem driver.
GNU General Public License v2.0
371 stars 45 forks source link

Incorrect syntax in manual? #95

Open Penguin-Guru opened 8 months ago

Penguin-Guru commented 8 months ago

https://github.com/phatina/simple-mtpfs/blob/5dfd25c72caf83bc85fc636804f1456bc0f6c1c6/man/simple-mtpfs.1#L7

That line indicates that the device (I'm not sure whether name or I.D. number matters) must be specified as the first command-line parameter. My experience is that specifying either causes the program to do nothing, while not specifying a device there allows the program to work as expected.

https://github.com/phatina/simple-mtpfs/blob/5dfd25c72caf83bc85fc636804f1456bc0f6c1c6/man/simple-mtpfs.1#L35

Here, the --device flag is said to declare a specified device. This seems to suggest that the above syntax for specifying devices is simply no longer the method supported. I am not sure though, because the line is indented past the -l flag label. Perhaps it applies only as a mode of -l.

https://github.com/phatina/simple-mtpfs/blob/5dfd25c72caf83bc85fc636804f1456bc0f6c1c6/man/simple-mtpfs.1#L33

-l claims to support the "\<device>" option, which is the same syntax indicated in the synopsis section. It does not mention the --device flag, which is why I wonder if --device is intended to be a top-level flag.


As a side note, it might also be a good idea to add a section that explains how to properly unmount. I don't use MTP very often, so when I do want to use it I always have to check the manual to recall the syntax.