Bug 8341 - tl-sso-password is not documented well
Summary: tl-sso-password is not documented well
Status: NEW
Alias: None
Product: ThinLinc
Classification: Unclassified
Component: Other (show other bugs)
Version: trunk
Hardware: PC Unknown
: P2 Normal
Target Milestone: LowPrio
Assignee: Bugzilla mail exporter
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-04-30 11:39 CEST by Tobias
Modified: 2024-07-05 18:47 CEST (History)
1 user (show)

See Also:
Acceptance Criteria:


Attachments

Description Tobias cendio 2024-04-30 11:39:49 CEST
The script tool tl-sso-password [1] and its sibling tl-sso-token-passphrase [2] are listed as end-user commands in the TAG [3]. However, they are not sufficiently easy to use even with help from the current documentation and the textual feedback is almost nonexistent. For instance, we rely on users being aware of how to check the return code, and some notion of piping.

Moreover, many common commands are seemingly incompatible e.g. 
> tl-sso-password | /usr/bin/gnome-software --password-on-stdin
> Unknown option --password-on-stdin
> /usr/bin/gnome-software --password-prog tl-sso-password
> Unknown option --password-prog
This is further complicated by bug 7754 which documents how some commands exit too quickly.

Perhaps these tools could be wrapped to increase user friendliness and textual feedback.

[1] https://www.cendio.com/resources/docs/tag/man/tl-sso-password.1.html
[2] https://www.cendio.com/resources/docs/tag/man/tl-sso-token-passphrase.1.html
[3] https://www.cendio.com/resources/docs/tag/commands.html
Comment 1 Tobias cendio 2024-07-05 16:40:29 CEST
(In reply to Tobias from comment #0)

The feeling that these tools lack documentation mainly stems from the fact that the --remove command is broken, and a corresponding bug has been opened on the subject (bug 8343). This was misinterpreted as insufficient documentation.

Also, it is intentional that these tools do not give much feedback since they're supposed to be paired with other tools and should therefor not report much beside their results.

In light of this, this bug reduces simply to the documentation for these tools could perhaps use some clarification.

Removing tl-sso-token-passphrase from the title since its documentation primarily refers to tl-sso-password for how-to-use.

Note You need to log in before you can comment on or make changes to this bug.