input.conf: add comments

These will be shown in the new keybinding list.

1 files changed, 122 insertions, 132 deletions

diff --git a/etc/input.conf b/etc/input.conf
index f84c0b7fca..71f7dbd7b9 100644
--- a/etc/input.conf
+++ b/etc/input.conf
@@ -29,156 +29,146 @@
 #default-bindings start
 
 #MBTN_LEFT     ignore              # don't do anything
-#MBTN_LEFT_DBL cycle fullscreen    # toggle fullscreen on/off
-#MBTN_RIGHT    cycle pause         # toggle pause on/off
-#MBTN_BACK     playlist-prev
-#MBTN_FORWARD  playlist-next
+#MBTN_LEFT_DBL cycle fullscreen    # toggle fullscreen
+#MBTN_RIGHT    cycle pause         # toggle pause/playback mode
+#MBTN_BACK     playlist-prev       # skip to the previous file
+#MBTN_FORWARD  playlist-next       # skip to the next file
 
 # Mouse wheels, touchpad or other input devices that have axes
 # if the input devices supports precise scrolling it will also scale the
 # numeric value accordingly
-#WHEEL_UP      seek 10
-#WHEEL_DOWN    seek -10
-#WHEEL_LEFT    add volume -2
-#WHEEL_RIGHT   add volume 2
+#WHEEL_UP      seek 10          # seek 10 seconds forward
+#WHEEL_DOWN    seek -10         # seek 10 seconds backward
+#WHEEL_LEFT    add volume -2    # lower the volume
+#WHEEL_RIGHT   add volume 2     # raise the volume
 
 ## Seek units are in seconds, but note that these are limited by keyframes
-#RIGHT seek  5
-#LEFT  seek -5
-#UP    seek  60
-#DOWN  seek -60
+#RIGHT seek  5                          # seek 5 seconds forward
+#LEFT  seek -5                          # seek 5 seconds backward
+#UP    seek  60                         # seek 1 minute forward
+#DOWN  seek -60                         # seek 1 minute backward
 # Do smaller, always exact (non-keyframe-limited), seeks with shift.
 # Don't show them on the OSD (no-osd).
-#Shift+RIGHT no-osd seek  1 exact
-#Shift+LEFT  no-osd seek -1 exact
-#Shift+UP    no-osd seek  5 exact
-#Shift+DOWN  no-osd seek -5 exact
-# Skip to previous/next subtitle (subject to some restrictions; see manpage)
-#Ctrl+LEFT   no-osd sub-seek -1
-#Ctrl+RIGHT  no-osd sub-seek  1
-# Adjust timing to previous/next subtitle
-#Ctrl+Shift+LEFT sub-step -1
-#Ctrl+Shift+RIGHT sub-step 1
-# Move video rectangle
-#Alt+left  add video-pan-x  0.1
-#Alt+right add video-pan-x -0.1
-#Alt+up    add video-pan-y  0.1
-#Alt+down  add video-pan-y -0.1
-# Zoom/unzoom video
-#Alt++     add video-zoom   0.1
-#Alt+-     add video-zoom  -0.1
-# Reset video zoom/pan settings
-#Alt+BS set video-zoom 0 ; set video-pan-x 0 ; set video-pan-y 0
-#PGUP add chapter 1                     # skip to next chapter
-#PGDWN add chapter -1                   # skip to previous chapter
-#Shift+PGUP seek 600
-#Shift+PGDWN seek -600
-#[ multiply speed 1/1.1                 # scale playback speed
-#] multiply speed 1.1
-#{ multiply speed 0.5
-#} multiply speed 2.0
-#BS set speed 1.0                       # reset speed to normal
-#Shift+BS revert-seek                   # undo previous (or marked) seek
-#Shift+Ctrl+BS revert-seek mark         # mark position for revert-seek
-#q quit
-#Q quit-watch-later
-#q {encode} quit 4
-#ESC set fullscreen no
-#ESC {encode} quit 4
+#Shift+RIGHT no-osd seek  1 exact       # seek exactly 1 second forward
+#Shift+LEFT  no-osd seek -1 exact       # seek exactly 1 second backward
+#Shift+UP    no-osd seek  5 exact       # seek exactly 5 seconds forward
+#Shift+DOWN  no-osd seek -5 exact       # seek exactly 5 seconds backward
+#Ctrl+LEFT   no-osd sub-seek -1         # seek to the previous subtitle
+#Ctrl+RIGHT  no-osd sub-seek  1         # seek to the next subtitle
+#Ctrl+Shift+LEFT sub-step -1            # change subtitle timing such that the previous subtitle is displayed
+#Ctrl+Shift+RIGHT sub-step 1            # change subtitle timing such that the next subtitle is displayed
+#Alt+left  add video-pan-x  0.1         # move the video right
+#Alt+right add video-pan-x -0.1         # move the video left
+#Alt+up    add video-pan-y  0.1         # move the video down
+#Alt+down  add video-pan-y -0.1         # move the video up
+#Alt++     add video-zoom   0.1         # zoom in
+#Alt+-     add video-zoom  -0.1         # zoom out
+#Alt+BS set video-zoom 0 ; set video-pan-x 0 ; set video-pan-y 0 # reset zoom and pan settings
+#PGUP add chapter 1                     # seek to the next chapter
+#PGDWN add chapter -1                   # seek to the previous chapter
+#Shift+PGUP seek 600                    # seek 10 minutes forward
+#Shift+PGDWN seek -600                  # seek 10 minutes backward
+#[ multiply speed 1/1.1                 # decrease the playback speed
+#] multiply speed 1.1                   # increase the playback speed
+#{ multiply speed 0.5                   # halve the playback speed
+#} multiply speed 2.0                   # double the playback speed
+#BS set speed 1.0                       # reset the speed to normal
+#Shift+BS revert-seek                   # undo the previous (or marked) seek
+#Shift+Ctrl+BS revert-seek mark         # mark the position for revert-seek
+#q quit                                 # exit
+#Q quit-watch-later                     # exit and remember the playback position
+#q {encode} quit 4                      # exit
+#ESC set fullscreen no                  # leave fullscreen
+#ESC {encode} quit 4                    # exit
 #p cycle pause                          # toggle pause/playback mode
 #. frame-step                           # advance one frame and pause
 #, frame-back-step                      # go back by one frame and pause
-#SPACE cycle pause
-#> playlist-next                        # skip to next file
-#ENTER playlist-next                    # skip to next file
-#< playlist-prev                        # skip to previous file
-#O no-osd cycle-values osd-level 3 1    # cycle through OSD mode
-#o show-progress
-#P show-progress
-#i script-binding stats/display-stats
-#I script-binding stats/display-stats-toggle
-#` script-binding console/enable
-#z add sub-delay -0.1                   # subtract 100 ms delay from subs
-#Z add sub-delay +0.1                   # add
-#x add sub-delay +0.1                   # same as previous binding (discouraged)
-#ctrl++ add audio-delay 0.100           # this changes audio/video sync
-#ctrl+- add audio-delay -0.100
-#Shift+g add sub-scale +0.1                  # increase subtitle font size
-#Shift+f add sub-scale -0.1                  # decrease subtitle font size
-#9 add volume -2
-#/ add volume -2
-#0 add volume 2
-#* add volume 2
-#m cycle mute
-#1 add contrast -1
-#2 add contrast 1
-#3 add brightness -1
-#4 add brightness 1
-#5 add gamma -1
-#6 add gamma 1
-#7 add saturation -1
-#8 add saturation 1
-#Alt+0 set current-window-scale 0.5
-#Alt+1 set current-window-scale 1.0
-#Alt+2 set current-window-scale 2.0
-# toggle deinterlacer (automatically inserts or removes required filter)
-#d cycle deinterlace
+#SPACE cycle pause                      # toggle pause/playback mode
+#> playlist-next                        # skip to the next file
+#ENTER playlist-next                    # skip to the next file
+#< playlist-prev                        # skip to the previous file
+#O no-osd cycle-values osd-level 3 1    # toggle displaying the OSD on user interaction or always
+#o show-progress                        # show playback progress
+#P show-progress                        # show playback progress
+#i script-binding stats/display-stats   # display information and statistics
+#I script-binding stats/display-stats-toggle # toggle displaying information and statistics
+#` script-binding console/enable        # open the console
+#z add sub-delay -0.1                   # shift subtitles 100 ms earlier
+#Z add sub-delay +0.1                   # delay subtitles by 100 ms
+#x add sub-delay +0.1                   # delay subtitles by 100 ms
+#ctrl++ add audio-delay 0.100           # change audio/video sync by delaying the audio
+#ctrl+- add audio-delay -0.100          # change audio/video sync by shifting the audio earlier
+#Shift+g add sub-scale +0.1             # increase the subtitle font size
+#Shift+f add sub-scale -0.1             # decrease the subtitle font size
+#9 add volume -2                        # lower the volume
+#/ add volume -2                        # lower the volume
+#0 add volume 2                         # raise the volume
+#* add volume 2                         # raise the volume
+#m cycle mute                           # toggle mute
+#1 add contrast -1                      # decrease the contrast
+#2 add contrast 1                       # increase the contrast
+#3 add brightness -1                    # decrease the brightness
+#4 add brightness 1                     # increase the brightness
+#5 add gamma -1                         # decrease the gamma
+#6 add gamma 1                          # increase the gamma
+#7 add saturation -1                    # decrease the saturation
+#8 add saturation 1                     # increase the saturation
+#Alt+0 set current-window-scale 0.5     # halve the window size
+#Alt+1 set current-window-scale 1.0     # reset the window size
+#Alt+2 set current-window-scale 2.0     # double the window size
+#d cycle deinterlace                    # toggle the deinterlacing filter
 #r add sub-pos -1                       # move subtitles up
-#R add sub-pos +1                       #                down
-#t add sub-pos +1                       # same as previous binding (discouraged)
-#v cycle sub-visibility
-#Alt+v cycle secondary-sub-visibility
-# stretch SSA/ASS subtitles with anamorphic videos to match historical
-#V cycle sub-ass-vsfilter-aspect-compat
-# switch between applying no style overrides to SSA/ASS subtitles, and
-# overriding them almost completely with the normal subtitle style
-#u cycle-values sub-ass-override "force" "no"
-#j cycle sub                            # cycle through subtitles
-#J cycle sub down                       # ...backwards
-#SHARP cycle audio                      # switch audio streams
-#_ cycle video
-#T cycle ontop                          # toggle video window ontop of other windows
+#R add sub-pos +1                       # move subtitles down
+#t add sub-pos +1                       # move subtitles down
+#v cycle sub-visibility                 # hide or show the subtitles
+#Alt+v cycle secondary-sub-visibility   # hide or show the secondary subtitles
+#V cycle sub-ass-vsfilter-aspect-compat # toggle stretching SSA/ASS subtitles with anamorphic videos to match the historical renderer
+#u cycle-values sub-ass-override "force" "no" # toggle overriding SSA/ASS subtitle styles with the normal styles
+#j cycle sub                            # switch subtitle track
+#J cycle sub down                       # switch subtitle track backwards
+#SHARP cycle audio                      # switch audio track
+#_ cycle video                          # switch video track
+#T cycle ontop                          # toggle placing the video on top of other windows
 #f cycle fullscreen                     # toggle fullscreen
-#s screenshot                           # take a screenshot
-#S screenshot video                     # ...without subtitles
-#Ctrl+s screenshot window               # ...with subtitles and OSD, and scaled
-#Alt+s screenshot each-frame            # automatically screenshot every frame
-#w add panscan -0.1                     # zoom out with -panscan 0 -fs
-#W add panscan +0.1                     #      in
-#e add panscan +0.1                     # same as previous binding (discouraged)
-# cycle video aspect ratios; "-1" is the container aspect
-#A cycle-values video-aspect-override "16:9" "4:3" "2.35:1" "-1"
-#POWER quit
-#PLAY cycle pause
-#PAUSE cycle pause
-#PLAYPAUSE cycle pause
-#PLAYONLY set pause no
-#PAUSEONLY set pause yes
-#STOP quit
-#FORWARD seek 60
-#REWIND seek -60
-#NEXT playlist-next
-#PREV playlist-prev
-#VOLUME_UP add volume 2
-#VOLUME_DOWN add volume -2
-#MUTE cycle mute
-#CLOSE_WIN quit
-#CLOSE_WIN {encode} quit 4
-#ctrl+w quit
-#E cycle edition                        # next edition
-#l ab-loop                              # Set/clear A-B loop points
+#s screenshot                           # take a screenshot of the video in its original resolution with subtitles
+#S screenshot video                     # take a screenshot of the video in its original resolution without subtitles
+#Ctrl+s screenshot window               # take a screenshot of the window with OSD and subtitles
+#Alt+s screenshot each-frame            # automatically screenshot every frame; issue this command again to stop taking screenshots
+#w add panscan -0.1                     # decrease panscan
+#W add panscan +0.1                     # shrink black bars by cropping the video
+#e add panscan +0.1                     # shrink black bars by cropping the video
+#A cycle-values video-aspect-override "16:9" "4:3" "2.35:1" "-1" # cycle the video aspect ratio ("-1" is the container aspect)
+#POWER quit                             # exit
+#PLAY cycle pause                       # toggle pause/playback mode
+#PAUSE cycle pause                      # toggle pause/playback mode
+#PLAYPAUSE cycle pause                  # toggle pause/playback mode
+#PLAYONLY set pause no                  # unpause
+#PAUSEONLY set pause yes                # pause
+#STOP quit                              # exit
+#FORWARD seek 60                        # seek 1 minute forward
+#REWIND seek -60                        # seek 1 minute backward
+#NEXT playlist-next                     # skip to the next file
+#PREV playlist-prev                     # skip to the previous file
+#VOLUME_UP add volume 2                 # raise the volume
+#VOLUME_DOWN add volume -2              # lower the volume
+#MUTE cycle mute                        # toggle mute
+#CLOSE_WIN quit                         # exit
+#CLOSE_WIN {encode} quit 4              # exit
+#ctrl+w quit                            # exit
+#E cycle edition                        # switch edition
+#l ab-loop                              # set/clear A-B loop points
 #L cycle-values loop-file "inf" "no"    # toggle infinite looping
-#ctrl+c quit 4
-#DEL script-binding osc/visibility      # cycle OSC display
-#ctrl+h cycle-values hwdec "auto" "no"  # cycle hardware decoding
-#F8 show_text ${playlist}               # show playlist
-#F9 show_text ${track-list}             # show list of audio/sub streams
+#ctrl+c quit 4                          # exit
+#DEL script-binding osc/visibility      # cycle OSC visibility between never, auto (mouse-move) and always
+#ctrl+h cycle-values hwdec "auto" "no"  # toggle hardware decoding
+#F8 show-text ${playlist}               # show the playlist
+#F9 show-text ${track-list}             # show the list of video, audio and sub tracks
 
 #
 # Legacy bindings (may or may not be removed in the future)
 #
-#! add chapter -1                       # skip to previous chapter
-#@ add chapter 1                        #         next
+#! add chapter -1                       # seek to the previous chapter
+#@ add chapter 1                        # seek to the next chapter
 
 #
 # Not assigned by default