Qalculate / libqalculate

Qalculate! library and CLI
https://qalculate.github.io/
GNU General Public License v2.0
1.85k stars 148 forks source link

difference between qalc man page and help message #638

Open howaboutuser opened 7 months ago

howaboutuser commented 7 months ago

QALC man page: https://qalculate.github.io/manual/qalc.html qalc version: 5.0.0

qalc -h

  1. '--' before option ('-' in help message)
  2. -h, --help (missing in help message)
  3. -s, --set (dqoption value(dq (-s, -set "OPTION VALUE" in help message)

help

  1. find, list [name] (find/list [NAME] in help message)
  2. help [command] (missing in help message)
  3. info (info NAME in help message)
  4. save, store name [category] [title] (save/store NAME [CATEGORY] [TITLE] in help message)
  5. to, convert, -> unit/to-command (to/convert/-> UNIT or "TO" COMMAND in help message)
  6. move index 1 index 2 (move [index 1] [index 2] for consistency)

help set

  1. 0 = none, 1 = radians, 2 = degrees, 3 = gradians (0 = none, 1 = radians, 2 = degrees, 3 = gradians, 4 = custom in help message)
  2. -1 = auto, 0 = exact, 1 = try exact, 2 = approximate, 3 = dual (-1 = auto, 0 = exact, 1 = try exact, 2 = approximate = dual in help message)
  3. 0 = /, 1 = division slash, 2 = division sign (0 = /, 1 = ∕, 2 = ÷ in help message)
  4. 0 = , 1 = multiplication dot, 2 = multiplication x, 3 = middle dot (0 = , 1 = ⋅, 2 = ×, 3 = · in help message)
  5. binary bits (bits) (missing in man page)
  6. ignore dot (on, off*) (missing in help message, and not work)
  7. temperature units (temperature calculation in help message)

help to

  1. decimals (missing in both)
hanna-kn commented 7 months ago

'--' before option ('-' in help message)

Both is valid.

-h, --help (missing in help message)

I assume that I thought it was unnecessary to show this (as this option is used for showing the help message). I will add it.

-s, --set (dqoption value(dq (-s, -set "OPTION VALUE" in help message)

\(dq is used for double quotes in man pages, but it is not shown properly in the HTML file (converted using roffit). I will edit the HTML file manually.

find, list [name] (find/list [NAME] in help message)

These are different ways to display the same information. I do not remember exactly, bit I probably determined that the first variant was more commonly used in man pages. I see no harm in not using the exact same format in the help message and in the man page.

move index 1 index 2 (move [index 1] [index 2] for consistency)

move index 1 [index 2] is more correct (the first argument is not optional).

0 = /, 1 = division slash, 2 = division sign (0 = /, 1 = ∕, 2 = ÷ in help message) 0 = , 1 = multiplication dot, 2 = multiplication x, 3 = middle dot (0 = , 1 = ⋅, 2 = ×, 3 = · in help message)

In the help message the appearance of the character which will be used can be displayed. This is not possible in the man page, and there is not the same need to save space.

ignore dot (on, off*) (missing in help message, and not work)

This is only shown if dot is not used as decimal separator.

I will fix the obvious errors, and add missing help text.

howaboutuser commented 2 months ago

qalc version: 5.2.0

help to

sexa3 (missing in help message)

howaboutuser commented 3 weeks ago

qalc version: 5.3.0 Has the manpage been updated? unkeep (missing in both) sex, sexa2, sexa3, sexagesimal (typo in manpage)

hanna-kn commented 3 weeks ago

The man page has been updated, but I missed fixing the "sex" typo. The web pages, including the HTML version of the man page, have not been updated yet.

howaboutuser commented 3 weeks ago

qalc version: 5.3.0 After man page updated (HTML version), I found following issue.

help

history (missing in man page) unkeep (missing in help message)

help set

imaginary j (imgj) appear in "Numerical Display" and "Parsing".