Document the incoming --sfx-volume option

fmang · Sep 22, 2018 · 54b7126 · 54b7126
1 parent 30b3161
commit 54b7126
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/share/man/oshu.1.in b/share/man/oshu.1.in
@@ -39,6 +39,10 @@ Perform a perfect run on the beatmap without any user interaction.
 \fB\-\-pause\fR
 Start the game in a paused state. Might be useful when you're starting the game
 from a terminal as you won't be holding your mouse when the game starts.
+.TP
+\fB\-\-sfx\-volume\fR
+Sets the volume of the effects (i.e hitsounds), minimum(~mute) is 0, maximum
+is 100
 
 .SH CONTROLS
 .PP

diff --git a/src/oshu/main.cc b/src/oshu/main.cc
@@ -59,6 +59,7 @@ static const char *help =
 	"  --version           Output version information.\n"
 	"  --autoplay          Perform a perfect run.\n"
 	"  --pause             Start the game paused.\n"
+	"  --sfx-volume        Changes the sound effects volume.\n"
 	"\n"
 	"Check the man page oshu(1) for details.\n"
 ;