Browse code

change auto generation of README.md with small and .ugly Makefile

Nat! authored on 15/02/2013 13:44:10
Showing 9 changed files
... ...
@@ -1,8 +0,0 @@
1
-
2
-## Author
3
-
4
-     Coded by Nat! 2013, Mulle kybernetiK. www.mulle‐kybernetik.com. The
5
-     lastest version should be available on github. http://github.com/mulle‐
6
-     nat/mulle‐plist‐utilities
7
-
... ...
@@ -4,4 +4,3 @@ Just say *sudo make install* and the files will end up in /usr/local.
4 4
 
5 5
 ---
6 6
 
7
-## man pages
... ...
@@ -20,11 +20,13 @@ done
20 20
 i=0
21 21
 for manpage in $*
22 22
 do
23
-   n=`expr $i + 1`
23
+   i=`expr $i + 1`
24 24
    if [ -f "$manpage" ]
25 25
    then
26 26
       echo "##" `basename $manpage .8` 
27
-      mulle-markdown-man-page-hack.sh < "$manpage" 
27
+      /bin/echo -n "<pre>"
28
+      nroff -man "$manpage" | col -b  
29
+      /bin/echo "</pre>"
28 30
       if [ $i -lt $n ] 
29 31
       then
30 32
          echo "---"
... ...
@@ -24,6 +24,6 @@ install:
24 24
 	( cd mulle-plist-fix; make install )
25 25
 	( cd mulle-plist-hack; make install )	
26 26
 
27
-README.md:	.ugly/README.md.header .ugly/README.md.footer $(MANPAGES)
27
+README.md:	.ugly/update-README.md.sh .ugly/README.md.header .ugly/README.md.footer $(MANPAGES)
28 28
 	.ugly/update-README.md.sh $(MANPAGES) > README.md
29 29
 
... ...
@@ -178,13 +178,3 @@ AUTHOR
178 178
 
179 179
 Darwin			       February 15, 2013			Darwin
180 180
 </pre>
181
-
182
-## Author
183
-
184
-Coded by Nat! 2013, Mulle kybernetiK. www.mulle‐kybernetik.com. The
185
-lastest version should be available from 
186
-
187
-http://www.mulle-kybernetik.com/software/git/mulle‐plist‐utilities
188
-
... ...
@@ -64,37 +64,19 @@ to output in hexadecimal format for inclusion in a unsigned char C-Array.
64 64
 .El                      \" Ends the list
65 65
 .Pp
66 66
 .Sh ENVIRONMENT      \" May not be needed
67
-.Bl -tag -width "MULLE_PLIST_HEADER" -indent \" ENV_VAR_1 is width of the string ENV_VAR_1
67
+.Bl -tag -width "MULLE_PLIST_HEADER"
68 68
 .It Ev MULLE_PLIST_HEADER
69 69
 The contents of this environment variable are prepended to the output.
70 70
 .It Ev MULLE_PLIST_FOOTER
71 71
 The contents of this environment variable are appended to the output.
72 72
 .El
73
-.\" .It Ev ENV_VAR_1
74
-.\" Description of ENV_VAR_1
75
-.\" .It Ev ENV_VAR_2
76
-.\" Description of ENV_VAR_2
77
-.\" .El                      
78
-.\".Sh FILES                \" File used or created by the topic of the man page
79
-.\".Bl -tag -width "/Users/joeuser/Library/really_long_file_name" -compact
80
-.\".It Pa /usr/share/file_name
81
-.\"FILE_1 description
82
-.\".It Pa /Users/joeuser/Library/really_long_file_name
83
-.\"FILE_2 description
84
-.\".El                      \" Ends the list
85
-.\" .Sh DIAGNOSTICS       \" May not be needed
86
-.\" .Bl -diag
87
-.\" .It Diagnostic Tag
88
-.\" Diagnostic informtion here.
89
-.\" .It Diagnostic Tag
90
-.\" Diagnostic informtion here.
91
-.\" .El
92
-.Sh SEE ALSO 
93
-.\" List links in ascending order by section, alphabetically within a section.
94
-.\" Please do not reference files that do not exist without filing a bug report
73
+.Sh SEE ALSO
95 74
 .Xr mulle-plist-from-files 8
96
-.\" .Sh BUGS              \" Document known, unremedied bugs 
97
-.\" .Sh HISTORY           \" Document history if command behaves in a unique manner
75
+.Xr mulle-plist-hack 8
76
+.Xr mulle-plist-fix 8
98 77
 .Sh AUTHOR
99
-Coded by Nat! 2013, Mulle kybernetiK. www.mulle-kybernetik.com. The lastest 
100
-version should be available on github. http://github.com/mulle-nat/mulle-plist-utilities
78
+Coded by Nat! 2013, Mulle kybernetiK. www.mulle-kybernetik.com. The latest 
79
+version should be available at:
80
+.Pp 
81
+http://www.mulle-kybernetik.com/software/git/mulle-plist-utilities
82
+
... ...
@@ -1,54 +1,56 @@
1
-.\"Modified from man(1) of FreeBSD, the NetBSD mdoc.template, and mdoc.samples.
2
-.\"See Also:
3
-.\"man mdoc.samples for a complete listing of options
4
-.\"man mdoc for the short list of editing options
5
-.\"/usr/share/misc/mdoc.template
6
-.Dd 7/2/13               \" DATE 
7
-.Dt mulle-plist-fix 8      \" Program name and manual section number 
8
-.Os Darwin
9
-.Sh NAME                 \" Section Header - required - don't modify 
10
-.Nm mulle-plist-fix
11
-.\" The following lines are read in generating the apropos(man -k) database. Use only key
12
-.\" words here as the database is built based on the words here and in the .ND line. 
13
-.\" Use .Nm macro to designate other names for the documented program.
14
-.Nd Fix ancient property list files
15
-.Sh SYNOPSIS             \" Section Header - required - don't modify
16
-.Nm
17
-.Ar file                \" [file]
18
-.Op Ar                   \" [file ...]
19
-.Sh DESCRIPTION          \" Section Header - required - don't modify
20
-Reads very, very old 
21
-.Em property list
22
-format from standard input and
23
-a more modern 
24
-.Em property plist
25
-format is then then written to standard output.
26
-.Pp
27
-.\" .It Ev ENV_VAR_1
28
-.\" Description of ENV_VAR_1
29
-.\" .It Ev ENV_VAR_2
30
-.\" Description of ENV_VAR_2
31
-.\" .El                      
32
-.\".Sh FILES                \" File used or created by the topic of the man page
33
-.\".Bl -tag -width "/Users/joeuser/Library/really_long_file_name" -compact
34
-.\".It Pa /usr/share/file_name
35
-.\"FILE_1 description
36
-.\".It Pa /Users/joeuser/Library/really_long_file_name
37
-.\"FILE_2 description
38
-.\".El                      \" Ends the list
39
-.\" .Sh DIAGNOSTICS       \" May not be needed
40
-.\" .Bl -diag
41
-.\" .It Diagnostic Tag
42
-.\" Diagnostic informtion here.
43
-.\" .It Diagnostic Tag
44
-.\" Diagnostic informtion here.
45
-.\" .El
46
-.Sh SEE ALSO 
47
-.\" List links in ascending order by section, alphabetically within a section.
48
-.\" Please do not reference files that do not exist without filing a bug report
49
-.Xr mulle-plist-fix 8
50
-.\" .Sh BUGS              \" Document known, unremedied bugs 
51
-.\" .Sh HISTORY           \" Document history if command behaves in a unique manner
52
-.Sh AUTHOR
53
-Coded by Nat! 2013, Mulle kybernetiK. www.mulle-kybernetik.com. The lastest 
54
-version should be available on github. http://github.com/mulle-nat/mulle-plist-utilities
55 1
\ No newline at end of file
2
+.\"Modified from man(1) of FreeBSD, the NetBSD mdoc.template, and mdoc.samples.
3
+.\"See Also:
4
+.\"man mdoc.samples for a complete listing of options
5
+.\"man mdoc for the short list of editing options
6
+.\"/usr/share/misc/mdoc.template
7
+.Dd 7/2/13               \" DATE 
8
+.Dt mulle-plist-fix 8      \" Program name and manual section number 
9
+.Os Darwin
10
+.Sh NAME                 \" Section Header - required - don't modify 
11
+.Nm mulle-plist-fix
12
+.\" The following lines are read in generating the apropos(man -k) database. Use only key
13
+.\" words here as the database is built based on the words here and in the .ND line. 
14
+.\" Use .Nm macro to designate other names for the documented program.
15
+.Nd Fix ancient property list files
16
+.Sh SYNOPSIS             \" Section Header - required - don't modify
17
+.Nm
18
+.Ar file                \" [file]
19
+.Op Ar                   \" [file ...]
20
+.Sh DESCRIPTION          \" Section Header - required - don't modify
21
+Reads very, very old 
22
+.Em property list
23
+format from standard input and
24
+a more modern 
25
+.Em property plist
26
+format is then then written to standard output.
27
+.Pp
28
+.\" .It Ev ENV_VAR_1
29
+.\" Description of ENV_VAR_1
30
+.\" .It Ev ENV_VAR_2
31
+.\" Description of ENV_VAR_2
32
+.\" .El                      
33
+.\".Sh FILES                \" File used or created by the topic of the man page
34
+.\".Bl -tag -width "/Users/joeuser/Library/really_long_file_name" -compact
35
+.\".It Pa /usr/share/file_name
36
+.\"FILE_1 description
37
+.\".It Pa /Users/joeuser/Library/really_long_file_name
38
+.\"FILE_2 description
39
+.\".El                      \" Ends the list
40
+.\" .Sh DIAGNOSTICS       \" May not be needed
41
+.\" .Bl -diag
42
+.\" .It Diagnostic Tag
43
+.\" Diagnostic informtion here.
44
+.\" .It Diagnostic Tag
45
+.\" Diagnostic informtion here.
46
+.\" .El
47
+.Sh SEE ALSO 
48
+.\" List links in ascending order by section, alphabetically within a section.
49
+.\" Please do not reference files that do not exist without filing a bug report
50
+.Xr mulle-plist-fix 8
51
+.\" .Sh BUGS              \" Document known, unremedied bugs 
52
+.\" .Sh HISTORY           \" Document history if command behaves in a unique manner
53
+.Sh AUTHOR
54
+Coded by Nat! 2013, Mulle kybernetiK. www.mulle-kybernetik.com. The latest 
55
+version should be available at:
56
+.Pp 
57
+http://www.mulle-kybernetik.com/software/git/mulle-plist-utilities
... ...
@@ -49,5 +49,7 @@ is then written to standard output.
49 49
 .\" .Sh BUGS              \" Document known, unremedied bugs 
50 50
 .\" .Sh HISTORY           \" Document history if command behaves in a unique manner
51 51
 .Sh AUTHOR
52
-Coded by Nat! 2013, Mulle kybernetiK. www.mulle-kybernetik.com. The lastest 
53
-version should be available on github. http://github.com/mulle-nat/mulle-plist-utilities
54 52
\ No newline at end of file
53
+Coded by Nat! 2013, Mulle kybernetiK. www.mulle-kybernetik.com. The latest 
54
+version should be available at:
55
+.Pp 
56
+http://www.mulle-kybernetik.com/software/git/mulle-plist-utilities
... ...
@@ -3,77 +3,74 @@
3 3
 .\"man mdoc.samples for a complete listing of options
4 4
 .\"man mdoc for the short list of editing options
5 5
 .\"/usr/share/misc/mdoc.template
6
-.Dd 11.02.13               \" DATE 
7
-.Dt mulle-plist-hack 1      \" Program name and manual section number 
6
+.Dd 9/2/13               \" DATE 
7
+.Dt mulle-plist-hack 8      \" Program name and manual section number 
8 8
 .Os Darwin
9 9
 .Sh NAME                 \" Section Header - required - don't modify 
10
-.Nm mulle-plist-hack,
11
-.\" The following lines are read in generating the apropos(man -k) database. Use only key
12
-.\" words here as the database is built based on the words here and in the .ND line. 
13
-.Nm Other_name_for_same_program(),
14
-.Nm Yet another name for the same program.
15
-.\" Use .Nm macro to designate other names for the documented program.
16
-.Nd This line parsed for whatis database.
10
+.Nm mulle-plist-hack
11
+.Nd Print, delete or change single key values in a property list.
17 12
 .Sh SYNOPSIS             \" Section Header - required - don't modify
18 13
 .Nm
19
-.Op Fl abcd              \" [-abcd]
20
-.Op Fl a Ar path         \" [-a path] 
21
-.Op Ar file              \" [file]
22
-.Op Ar                   \" [file ...]
23
-.Ar arg0                 \" Underlined argument - use .Ar anywhere to underline
24
-arg2 ...                 \" Arguments
14
+.Op Fl s Ar style       
15
+.Op Fl c Ar compression
16
+.Op Fl f Ar format
25 17
 .Sh DESCRIPTION          \" Section Header - required - don't modify
26
-Use the .Nm macro to refer to your program throughout the man page like such:
27
-.Nm
28
-Underlining is accomplished with the .Ar macro like this:
29
-.Ar underlined text .
18
+Reads a 
19
+.Em property plist 
20
+from standard input, does some user supplied manipulations on it and writes 
21
+it's result to standard output.
30 22
 .Pp                      \" Inserts a space
31
-A list of items with descriptions:
32
-.Bl -tag -width -indent  \" Begins a tagged list 
33
-.It item a               \" Each item preceded by .It macro
34
-Description of item a
35
-.It item b
36
-Description of item b
37
-.El                      \" Ends the list
38
-.Pp
39
-A list of flags and their descriptions:
23
+The following options are available:
40 24
 .Bl -tag -width -indent  \" Differs from above in tag removed 
41
-.It Fl a                 \"-a flag as a list item
42
-Description of -a flag
43
-.It Fl b
44
-Description of -b flag
45
-.El                      \" Ends the list
25
+.It Fl s                 \"-s flag as a list item
26
+Change the style of the produced property list:
27
+.Pp
28
+.Sy condensed
29
+only outputs a minimal number of characters for the property list (default).
30
+.Pp
31
+.Sy pretty
32
+is the output created by -[NSObject description].
33
+.Pp
34
+.Sy xml
35
+produces XML property list output.
36
+.Sy binary
37
+produces binary property list output.
46 38
 .Pp
47
-.\" .Sh ENVIRONMENT      \" May not be needed
48
-.\" .Bl -tag -width "ENV_VAR_1" -indent \" ENV_VAR_1 is width of the string ENV_VAR_1
49
-.\" .It Ev ENV_VAR_1
50
-.\" Description of ENV_VAR_1
51
-.\" .It Ev ENV_VAR_2
52
-.\" Description of ENV_VAR_2
53
-.\" .El                      
54
-.Sh FILES                \" File used or created by the topic of the man page
55
-.Bl -tag -width "/Users/joeuser/Library/really_long_file_name" -compact
56
-.It Pa /usr/share/file_name
57
-FILE_1 description
58
-.It Pa /Users/joeuser/Library/really_long_file_name
59
-FILE_2 description
39
+.It Fl c                  \"-c flag as a list item
40
+Use a binary compression method:
41
+.Pp
42
+.Sy none
43
+to not compress (default), use 
44
+.Pp
45
+.Sy zlib
46
+to create a zlib compressed blob.
47
+.Pp
48
+.It Fl f                 \"-f flag as a list item
49
+Choose an output format:
50
+.Pp
51
+.Sy escaped
52
+for inclusion into a C-String (default). Not useful in combination with compression.
53
+.Pp
54
+.Sy plain
55
+for output as is.
56
+.Pp
57
+.Sy hex
58
+to output in hexadecimal format for inclusion in a unsigned char C-Array.
60 59
 .El                      \" Ends the list
61
-.\" .Sh DIAGNOSTICS       \" May not be needed
62
-.\" .Bl -diag
63
-.\" .It Diagnostic Tag
64
-.\" Diagnostic informtion here.
65
-.\" .It Diagnostic Tag
66
-.\" Diagnostic informtion here.
67
-.\" .El
68
-.Sh SEE ALSO 
69
-.\" List links in ascending order by section, alphabetically within a section.
70
-.\" Please do not reference files that do not exist without filing a bug report
71
-.Xr a 1 , 
72
-.Xr b 1 ,
73
-.Xr c 1 ,
74
-.Xr a 2 ,
75
-.Xr b 2 ,
76
-.Xr a 3 ,
77
-.Xr b 3 
78
-.\" .Sh BUGS              \" Document known, unremedied bugs 
79
-.\" .Sh HISTORY           \" Document history if command behaves in a unique manner
80 60
\ No newline at end of file
61
+.Pp
62
+.Sh ENVIRONMENT      \" May not be needed
63
+.Bl -tag -width "MULLE_PLIST_HEADER" -indent \" ENV_VAR_1 is width of the string ENV_VAR_1
64
+.It Ev MULLE_PLIST_HEADER
65
+The contents of this environment variable are prepended to the output.
66
+.It Ev MULLE_PLIST_FOOTER
67
+The contents of this environment variable are appended to the output.
68
+.El
69
+.Sh SEE ALSO
70
+.Xr mulle-plist-from-files 8
71
+.Xr mulle-plist-hack 8
72
+.Xr mulle-plist-fix 8
73
+.Sh AUTHOR
74
+Coded by Nat! 2013, Mulle kybernetiK. www.mulle-kybernetik.com. The latest 
75
+version should be available at:
76
+.Pp 
77
+http://www.mulle-kybernetik.com/software/git/mulle-plist-utilities