ObjFW  Check-in [15b4690419]

Overview
Comment:Improve style of manpages
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: 15b469041997cdf11ea1acd675578248f722d21997ab8d1ff210a217d8a5bd27
User & Date: js on 2024-09-01 09:04:02
Other Links: manifest | tags
Context
2024-09-01
09:24
Add manpage for objfw-new check-in: 5ccfd65db4 user: js tags: trunk
09:04
Improve style of manpages check-in: 15b4690419 user: js tags: trunk
2024-08-31
20:45
objfw-config.1: Improve style check-in: d473ceacbe user: js tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Modified utils/objfw-compile.1 from [f583f5b65d] to [8fb3ce289e].

︙
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

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








-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+








\fB\-o\fR \fIoutname\fR
\fIsources\fR
.SH DESCRIPTION
.B objfw-compile
is a program to compile simple projects using ObjFW.
.SH OPTIONS
.TP
.BR \-o " " \fIoutname\fR
.BR \fB\-o\fR " " \fIoutname\fR
Specify the output name (not the file name!).
.TP
.BR \-\-arc
.BR \fB\-\-arc\fR
Use automatic reference counting.
.TP
.BR \-\-lib " " \fIversion\fR
.BR \fB\-\-lib\fR " " \fIversion\fR
Compile a static library (with the specified version) instead of an application.
.TP
.BR \-\-plugin
.BR \fB\-\-plugin\fR
Compile a plugin instead of an application.
.TP
.BR \-\-package " " \fIname\fR
.BR \fB\-\-package\fR " " \fIname\fR
Use the specified package.
.TP
.BR \-\-builddir " " \fIdir\fR
.BR \fB\-\-builddir\fR " " \fIdir\fR
Place built objects into the specified directory.
.TP
.BR \-D\fIdefine\fR ", " \-D " " \fIdefine\fR
.BR \fB\-D\fIdefine\fR ", " \fB\-D\fR " " \fIdefine\fR
Pass the specified define to the compiler.
.TP
.BR \-framework " " \fIframework\fR
.BR \fB\-framework\fR " " \fIframework\fR
Pass the specified -framework argument to the linker (macOS / iOS only).
.TP
.BR \-f\fIflag\fR
.BR \fB\-f\fIflag\fR
Pass the specified -f flag to the compiler.
.TP
.BR \-F\fIdir\fR ", " \-F " " \fIdir\fR
.BR \fB\-F\fIdir\fR ", " \fB\-F\fR " " \fIdir\fR
Pass the specified -F flag to the linker (macOS / iOS only).
.TP
.BR \-g\fIflag\fR
.BR \fB\-g\fIflag\fR
Pass the specified -g flag to the compiler.
.TP
.BR \-I\fIdir\fR ", " \-I " " \fIdir\fR
.BR \fB\-I\fIdir\fR ", " \fB\-I\fR " " \fIdir\fR
Pass the specified -I flag to the compiler.
.TP
.BR \-l\fIlib\fR ", " \-l " " \fIlib\fR
.BR \fB\-l\fIlib\fR ", " \fB\-l\fR " " \fIlib\fR
Pass the specified -l flag to the linker.
.TP
.BR \-L\fIdir\fR ", " \-L " " \fIdir\fR
.BR \fB\-L\fIdir\fR ", " \fB\-L\fR " " \fIdir\fR
Pass the specified -L flag to the linker.
.TP
.BR \-m\fIflag\fR
.BR \fB\-m\fIflag\fR
Pass the specified -m flag to the compiler.
.TP
.BR \-O\fIlevel\fR
.BR \fB\-O\fIlevel\fR
Pass the specified -O flag to the compiler.
.TP
.BR \-pthread
.BR \fB\-pthread\fR
Pass -pthread to the compiler and linker.
.TP
.BR \-std=\fIlang\fR
.BR \fB\-std=\fIlang\fR
Pass the specified -std= flag to the compiler.
.TP
.BR \-Wl,\fIflag\fR
.BR \fB\-Wl,\fIflag\fR
Pass the specified -Wl, flag to the linker.
.TP
.BR \-W\fIwarning\fR
.BR \fB\-W\fIwarning\fR
Pass the specified -W flag to the compiler.
.TP
.BR \-\-help
.BR \fB\-\-help\fR
Show the help.
.SH EXAMPLES
Compile a program with two source files:
.PP
	objfw-compile -o myprog MyProg.m SomeClass.m
.PP
Compile a library with library version 1.0:
︙

Modified utils/objfw-config.1 from [838fc11326] to [f708f3815d].

︙
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

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








-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+



-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+


-
+








.B objfw-config
[\fBoptions\fR]
.SH DESCRIPTION
.B objfw-config
is a program which outputs various flags needed to compile software using ObjFW.
.SH OPTIONS
.TP
.BR \-\-all
.BR \fB\-\-all\fR
Outputs all flags + libs.
.TP
.BR \-\-arc
.BR \fB\-\-arc\fR
Outputs the required \fBOBJCFLAGS\fR to use ARC.
.TP
.BR \-\-cflags
.BR \fB\-\-cflags\fR
Outputs the required \fBCFLAGS\fR.
.TP
.BR \-\-cppflags
.BR \fB\-\-cppflags\fR
Outputs the required \fBCPPFLAGS\fR.
.TP
.BR \-\-cxxflags
.BR \fB\-\-cxxflags\fR
Outputs the required \fBCXXFLAGS\fR.
.TP
.BR \-\-framework-libs
.BR \fB\-\-framework-libs\fR
Outputs the required \fBLIBS\fR, preferring frameworks.
.TP
.BR \-\-help
.BR \fB\-\-help\fR
Prints the help.
.TP
.BR \-\-ldflags
.BR \fB\-\-ldflags\fR
Outputs the required \fBLDFLAGS\fR.
.TP
.BR \-\-libs
.BR \fB\-\-libs\fR
Outputs the required \fBLIBS\fR.
.TP
.BR \-\-lib-cflags
.BR \fB\-\-lib-cflags\fR
Outputs \fBCFLAGS\fR for building a library.
.TP
.BR \-\-lib-ldflags
.BR \fB\-\-lib-ldflags\fR
Outputs \fBLDFLAGS\fR for building a library.
.TP
.BR \-\-lib-prefix
.BR \fB\-\-lib-prefix\fR
Outputs the prefix for libraries.
.TP
.BR \-\-lib-suffix
.BR \fB\-\-lib-suffix\fR
Outputs the suffix for libraries.
.TP
.BR \-\-objc
.BR \fB\-\-objc\fR
Outputs the \fBOBJC\fR used to compile ObjFW. It is required to use the same
\fBOBJC\fR that was used to compile ObjFW.
.TP
.BR \-\-objcflags
.BR \fB\-\-objcflags\fR
Outputs the required \fBOBJCFLAGS\fR.
.TP
.BR \-\-package " " \fIname\fR
.BR \fB\-\-package\fR " " \fIname\fR
Additionally outputs the flags for the specified package.
.TP
.BR \-\-packages-dir
.BR \fB\-\-packages-dir\fR
Outputs the directory where flags for packages are stored.
.TP
.BR \-\-plugin-cflags
.BR \fB\-\-plugin-cflags\fR
Outputs \fBCFLAGS\fR for building a plugin.
.TP
.BR \-\-plugin-ldflags
.BR \fB\-\-plugin-ldflags\fR
Outputs \fBLDFLAGS\fR for building a plugin.
.TP
.BR \-\-plugin-suffix
.BR \fB\-\-plugin-suffix\fR
Outputs the suffix for plugins.
.TP
.BR \-\-prog-suffix
.BR \fB\-\-prog-suffix\fR
Outputs the suffix for binaries.
.TP
.BR \-\-reexport
.BR \fB\-\-reexport\fR
Outputs \fBLDFLAGS\fR to reexport ObjFW.
.TP
.BR \-\-rpath
.BR \fB\-\-rpath\fR
Outputs \fBLDFLAGS\fR for using rpath.
.TP
.BR \-\-static-libs
.BR \fB\-\-static-libs\fR
Outputs the required \fBLIBS\fR to link ObjFW statically.
.TP
.BR \-\-version
.BR \fB\-\-version\fR
Outputs the installed ObjFW version.
.SH EXAMPLES
Print \fBOBJCFLAGS\fR and \fBCPPFLAGS\fR:
.PP
	objfw-config \-\-objcflags \-\-cppflags
.PP
Print \fBLIBS\fR and \fBLDFLAGS\fR for ObjFW and ObjFWTLS:
︙