Merge pull request #96 from winny-/document_format

Document format specifiers

slop.1

@@ -34,7 +34,7 @@ Sets the selection rectangle's color. Supports RGB or RGBA input. Depending on t
 This sets the vertex shader, and fragment shader combo to use when drawing the final framebuffer to the screen. This obviously only works when OpenGL is enabled. The shaders are loaded from ~/.config/slop. See https://github.com/naelstrof/slop for more information on how to create your own shaders.
 .TP
 .BR \-f ", " \-\-format=\fISTRING\fR
-Sets the output format for slop. Format specifiers are %x, %y, %w, %h, %i, %c, and %g. If actual percentage signs are desired in output, use a double percentage sign like so `%%`.
+Sets the output format for slop. Format specifiers are %x (x offset), %y (y offset), %w (width), %h (height), %i (window id), %c (1 if cancelled, 0 otherwise), %g (geometry - `%wx%h+%x+%y'), and %% for a literal percent sign.
 .TP
 .BR \-n ", " \-\-nodecorations=INT
 Sets the level of aggressiveness when trying to remove window decorations. `0' is off, `1' will try lightly to remove decorations, and `2' will recursively descend into the root tree until it gets the deepest available visible child under the mouse. Defaults to `0'. Supplying slop with just `-n` is equivalent to supplying `-n1`.

src/main.cpp

@@ -191,8 +191,12 @@ void printHelp() {
     std::cout << "  -r, --shader=STRING           Sets the shader to load and use from\n";
     std::cout << "                                  ~/.config/slop/\n";
     std::cout << "  -f, --format=STRING           Set the output format string. Format specifiers\n";
-    std::cout << "                                  are %x, %y, %w, %h, %i, %g, and %c.\n";
-    std::cout << "                                  (default=`%g\n')\n";
+    std::cout << "                                  are %x (x offset), %y (y offset), %w (width),\n";
+    std::cout << "                                  %h (height), %i (window id),\n";
+    std::cout << "                                  %g (geometry - `%wx%h+%x+%y\'),\n";
+    std::cout << "                                  %c (1 if cancelled, 0 otherwise),\n";
+    std::cout << "                                  and %% for a literal percent sign.\n";
+    std::cout << "                                  (default=`%g')\n";
     std::cout << "  -o, --noopengl                Disable graphics acceleration.\n";
     std::cout << "Examples\n";
     std::cout << "    $ # Gray, thick, transparent border for maximum visiblity.\n";