Bug 5289

Summary: Inconsistent use of option and argument in "Commands on the ThinLinc Server" chapter
Product: ThinLinc Reporter: Karl Mikaelsson <derfian>
Component: DocumentationAssignee: Pierre Ossman <ossman>
Status: CLOSED FIXED    
Severity: Normal CC: derfian, samuel
Priority: P2 Keywords: prosaic, samuel_tester
Version: trunk   
Target Milestone: 4.14.0   
Hardware: PC   
OS: Unknown   
Acceptance Criteria:

Description Karl Mikaelsson cendio 2014-10-09 12:33:45 CEST
> tl-config options
> tl-run-rdesktop [options]
> tl-run-unixapp [arguments]
> tl-run-winapp [-D] [-T title] [arguments] windows-app [application arguments]
> tl-wfica [options] [connection file]

etc, etc...
Comment 1 Pierre Ossman cendio 2021-10-28 08:58:55 CEST
Fixed in r37553 for bug 4951.
Comment 2 Samuel Mannehed cendio 2021-10-29 13:07:02 CEST
There are some incorrect page-breaks in the PDF. One example is 'tl-ssh-all' in the "Commands in /opt/thinlinc/libexec"-section. The page-break is inbetween the command name and the corresponding description:

> tl-ssh-all
--PAGE-BREAKS HERE--

>   This command is used to perform shell commands on all agents in a ThinLinc
>   cluster. It works by running the ssh command against all agent servers in the
>   cluster. When using this command, it’s convenient if password-less SSH login
>   between the servers in the clusters has been set up.

This shouldn't happen.
Comment 3 Pierre Ossman cendio 2021-10-29 16:19:36 CEST
Ooops. I wasn't using the proper syntax for definition lists. Directives allow (require?) a blank line there, but definition lists forbid them.
Comment 5 Pierre Ossman cendio 2021-10-29 16:20:45 CEST
Should be fixed now. There were a lot of instances of this problem once you knew what to look for.
Comment 6 Samuel Mannehed cendio 2021-10-29 18:18:32 CEST
I still get a page break immediately after "Export - Printer" in the PDF in the Client configuration chapter. Shouldn't it just move that 'header' down to the next page?
Comment 7 Pierre Ossman cendio 2021-11-01 09:39:10 CET
Apparently that wasn't enough since rst2pdf has a known bug for definition lists:

https://github.com/rst2pdf/rst2pdf/issues/286

However the fix seems trivial, so I don't know why they haven't done anything about it.
Comment 9 Pierre Ossman cendio 2021-11-01 11:07:17 CET
That should hopefully be the last thing and definition lists now work well.
Comment 10 Samuel Mannehed cendio 2021-11-01 12:50:02 CET
Unfortunately the "PulseAudio applications" heading in the "Using Sound Device Redirection" section appears at the end of a page in the PDF. It should be put on the next page if no text from the paragraph can fit.
Comment 11 Pierre Ossman cendio 2021-11-01 14:50:14 CET
That is a general issue, so let's handle that on bug 4951.
Comment 12 Samuel Mannehed cendio 2021-11-02 13:25:24 CET
(In reply to Pierre Ossman from comment #11)
> That is a general issue, so let's handle that on bug 4951.

Fair enough, that means we can close this. I have verified that we use the same style for all options and arguments in the TAG now. Looks good both in the PDF and in the HTML.