aboutsummaryrefslogtreecommitdiff
path: root/misc/grabc/manpage.diff
blob: a3ef773f4b030779116016c7917dc3a1e8cbdcae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
diff --git a/Makefile b/Makefile
index 5de8e52..adc88e5 100644
--- a/Makefile
+++ b/Makefile
@@ -28,13 +28,13 @@ OBJS = grabc.o
 	rm -f $@
 	$(CC) $(CFLAGS) -c $*.c
 
-all: $(PROGNAME)
+all: $(PROGNAME) doc
 
 $(PROGNAME) : $(OBJS)
 	$(CC) $(CFLAGS) -o $(PROGNAME) $(OBJS) $(LIBS)
 
 doc:
-	pod2man grabc.pod > grabc.1
+	pod2man -cSlackBuilds.org -r1.0.2 grabc.pod > grabc.1
 
 install: installdirs install-bin install-man
 
diff --git a/grabc.pod b/grabc.pod
index 85f2c2f..627bc22 100644
--- a/grabc.pod
+++ b/grabc.pod
@@ -4,42 +4,75 @@ grabc - A tool to identify a pixel color of an X Window.
 
 =head1 SYNOPSIS
 
- grabc v1.0.2
- A program to identify a pixel color of an X Window
- by muquit@muquit.com https://www.muquit.com/
- 
- Usage: grabc [options]
- Where the options are:
-  -v         - show version info
-  -h         - show this usage
-  -hex       - print pixel value as Hex on stdout
-  -rgb       - print pixel value as RGB on stderr
-  -W         - print the Window id at mouse click
-  -w id      - window id in hex, use -l +x+y
-  -l +x+y    - pixel co-ordinate. requires window id
-  -d         - show debug messages
-  -a         - Print all 16 bits of color. Default is high order 8 bits
- Example:
- * Print pixel color in hex on stdout:
-    $ grabc
- * Show usage:
-    $ grabc -h
- * Print Window Id (Note the upper case W):
-    $ grabc -W
- * Print pixel color of Window iwith id 0x13234 at location 10,20
-    $ grabc -w 0x13234 -l +10+20
+grabc [B<-v>] [B<-h>] [B<-W>] [B<-d>] [B<-a>] [B<-hex>] [B<-rgb>] [B<-w> I<window-id>] [B<-l> +I<x>+I<y>]
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-v>
+
+Show version info and exit.
+
+=item B<-h>
+
+Show usage and exit.
+
+=item B<-hex>
+
+Print pixel value as Hex on B<stdout>.
+
+=item B<-rgb>
+
+Print pixel value as RGB on B<stderr>.
+
+=item B<-W>
+
+Print the window id at mouse click.
+
+=item B<-w> I<window-id>
+
+Window id in hex, use with B<-l> I<+x+y>.
+
+=item B<-l> I<+x+y>
+
+Pixel co-ordinate. Requires window id.
+
+=item B<-d>
+
+Show debug messages.
+
+=item B<-a>
+
+Print all 16 bits of color. Default is high order 8 bits.
+
+=back
 
 =head1 DESCRIPTION
 
-grabc is a simple but very useful program to determine the color string in 
+B<grabc> is a simple but very useful program to determine the color string in 
 hex (or in RGB components) by clicking on a pixel on the screen. While web 
-browsing, lots of time you find a nice color and wonder what color is that. 
-Well just use grabc!
+browsing, lots of times you find a nice color and wonder, "What color is that"?
+Well, just use B<grabc>!
 
 When this program is run, the mouse pointer is grabbed and changed to a 
 cross hair and when the mouse is clicked, the color of the clicked pixel 
 is written to stdout in hex prefixed with #. 
 
+=head1 EXAMPLES
+
+Print pixel color in hex on stdout:
+
+    $ grabc
+
+Print Window Id (Note the upper case W):
+
+    $ grabc -W
+
+Print pixel color of window with id 0x13234 at location 10,20
+
+    $ grabc -w 0x13234 -l +10+20
+
 =head1 LICENSE
 
 MIT
@@ -47,4 +80,7 @@ MIT
 =head1 AUTHOR
 
 grabc is written by Muhammad Muquit E<lt>muquit@muquit.comE<gt>.
+
+=head1 SEE ALSO
+
 Homepage: L<https://www.muquit.com/>.