The current documentation of sub-scale-by-window and sub-scale-with-window doesn't sufficiently convey what these options do exactly. Specifically, the described effects of disabling one option is only true when the other option is not disabled. The "clarification" of sub-scale-with-window option only adds more confusion, when the effect of that option is already told in more detail before (it scaled with window instead of video). Clarify this by listing the effects of all combinations of these options.
Showing the changes to DOCS (1 of 1 file). Show all
Unified · Split
| @@ -2387,27 +2387,28 @@ Subtitles · 2386 unmodified lines | ||
| 2387 | 2387 | |
| 2388 | 2388 | ``--sub-scale-by-window=<yes|no>`` |
| 2389 | 2389 | Whether to scale subtitles with the window size (default: yes). If this is |
| 2390 | − disabled, changing the window size won't change the subtitle font size. | |
| 2390 | + disabled while ``--sub-scale-with-window`` is set to yes, changing the window | |
| 2391 | + size won't change the subtitle font size. | |
| 2391 | 2392 | |
| 2392 | 2393 | Affects plain text subtitles only (or ASS if ``--sub-ass-override`` is set |
| 2393 | 2394 | high enough). |
| 2394 | 2395 | |
| 2395 | 2396 | ``--sub-scale-with-window=<yes|no>`` |
| 2396 | − Make the subtitle font size relative to the window, instead of the video. | |
| 2397 | − This is useful if you always want the same font size, even if the video | |
| 2398 | − doesn't cover the window fully, e.g. because screen aspect and window | |
| 2399 | − aspect mismatch (and the player adds black bars). | |
| 2400 | − | |
| 2401 | − Default: yes. | |
| 2402 | − | |
| 2403 | − This option is misnamed. The difference to the confusingly similar sounding | |
| 2404 | − option ``--sub-scale-by-window`` is that ``--sub-scale-with-window`` still | |
| 2405 | − scales with the approximate window size, while the other option disables | |
| 2406 | − this scaling. | |
| 2397 | + Make the subtitle font size relative to the window (default: yes). If this is | |
| 2398 | + disabled while ``--sub-scale-by-window`` is set to yes, the subtitle font | |
| 2399 | + size is scaled relative to the video size instead. | |
| 2407 | 2400 | |
| 2408 | 2401 | Affects plain text subtitles only (or ASS if ``--sub-ass-override`` is set |
| 2409 | 2402 | high enough). |
| 2410 | 2403 | |
| 2404 | + .. note:: | |
| 2405 | + | |
| 2406 | + By default, the subtitle font size is scaled with the window size. | |
| 2407 | + To make the font size constant, set only ``--sub-scale-by-window`` to no. | |
| 2408 | + To make the font size scale with video size instead, set only | |
| 2409 | + ``--sub-scale-with-window`` to no. | |
| 2410 | + It's not meaningful to set both options to no. | |
| 2411 | + | |
| 2411 | 2412 | ``--sub-ass-scale-with-window=<yes|no>`` |
| 2412 | 2413 | Like ``--sub-scale-with-window``, but affects subtitles in ASS format only. |
| 2413 | 2414 | Like ``--sub-scale``, this can break ASS subtitles. |