compton icon indicating copy to clipboard operation
compton copied to clipboard

description of --sw-opti in manpage describes non-existant vsync options.

Open bobpaul opened this issue 5 years ago • 0 comments

Platform: Archlinux

Compton version: $ compton --version v7.4 $ pacman -Qi compton | grep Version Version : 7.4-1

Steps of reproduction

  1. man compton
  2. search/scroll to the sw-opti section
  3. note the text reads:
       `--vsync`
           Enable VSync.

       --sw-opti
           Limit compton to repaint at most once every 1 / refresh_rate second to boost performance. This should not be
           used with --vsync drm/opengl/opengl-oml as they essentially does --sw-opti's job already, unless you wish to
           specify a lower refresh rate than the actual value.
  1. observe that --vsync no longer takes options

Expected behavior

Perhaps the vsync documentation should be expanded to state more than "enables vsync", as it does not lock the frame rate to the monitor vsync as this option does in other software. It's not entirely clear to me what the --vsync option does do; I get the same glmark framerate with the option enabled or not.

Definitely --sw-opti description should not reference options that have been removed. I'm not sure what the interaction between --sw-opti and --vsync currently; should the two options just never be used together? Or does compton do different things in different circumstances? I guess --sw-opti is deprecated, so maybe it doesn't matter...

bobpaul avatar Oct 16 '19 17:10 bobpaul