gryf/wmaker
1
0
Fork 0
mirror of https://github.com/gryf/wmaker.git synced 2026-01-08 23:04:15 +01:00
Code Issues Projects Releases Wiki Activity

doc: updated man pages for many tools

Browse Source 
This patch perform simple fixes to the man pages and tool help page:
 - minor style updates, to get cleaner pages
 - option re-ordering, to have them in alphabetic order (easier to search for)
 - consistency updates for descriptions and number of dash
 - spell-checking

The biggest changes are:
 - wmagnify: the option 'vdisplay' was not documented at all;

 - getstyle: the list of attributes that are taken for the Style are now
described in their own section to clarify the page;

 - setstyle: the help page left thinking that the file argument was
optional, which is not the case;

 - wdread: as the Exit Code may be useful, and it is not unusable, it is
now documented;

 - wmgenmenu: added information about how the content of the menu is
generated;

 - wmsetbg: added a section about dithering/best-match because as nowadays
most screens are in True Color, the reason for the option may not be clear.

Signed-off-by: Christophe CURIS <christophe.curis@free.fr>
This commit is contained in:
Christophe CURIS
2015-04-06 17:57:58 +02:00
committed by Carlos R. Mafra
parent f6c9410ee7
commit c743c4b77b
16 changed files with 262 additions and 194 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
util/seticons.c
View File

@@ -42,7 +42,7 @@ static const char *prog_name;
static noreturn void print_help(int print_usage, int exitval)
{
printf("Usage: %s [-h] [-v] [file]\n", prog_name);
printf("Usage: %s [-h] [-v] file\n", prog_name);
if (print_usage) {
puts("Reads icon configuration from FILE and updates Window Maker.");
puts("");

8
util/wmagnify.c
View File

@@ -436,9 +436,11 @@ int main(int argc, char **argv)
printf("Usage: %s [options]\n", argv[0]);
puts("Options:");
puts(" -display <display> display that should be used");
puts(" -m <number> change magnification factor (default 2)");
puts(" -r <number> change refresh delay, in milliseconds (default 200)");
puts(" -display <display>\tdisplay where to magnification is shown");
puts(" -m <number>\t\tchange magnification factor (default 2)");
puts(" -r <number>\t\tchange refresh delay, in milliseconds (default 200)");
puts(" -vdisplay <display>\tdisplay from which the magnification is taken");
puts(" -h, --help\t\tdisplay this help page");
puts("Keys:");
puts(" 1,2,3,4,5,6,7,8,9 change the magnification factor");
puts(" <space>, f freeze the 'camera', making it magnify only the current\n"

2
util/wmsetbg.c
View File

@@ -1153,7 +1153,7 @@ static void print_help(void)
puts("Sets the workspace background to the specified image or a texture and");
puts("optionally update Window Maker configuration");
puts("");
puts(" -display display to use");
puts(" -display <display> display to use");
puts(" -d, --dither dither image");
puts(" -m, --match match colors");
puts(" -S, --smooth smooth scaled image");

4
util/wxpaste.c
View File

@@ -39,8 +39,8 @@ static const char *prog_name;
static void print_help(void)
{
printf("Usage: %s [OPTIONS] [FILE]\n", prog_name);
puts("Copies data from X selection or cutbuffer to FILE or stdout.");
printf("Usage: %s [OPTIONS]\n", prog_name);
puts("Copies data from X selection or cutbuffer to stdout.");
puts("");
puts(" -display display display to use");
puts(" --cutbuffer number cutbuffer number to get data from");