neon-config.1 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. '\" t
  2. .\" Title: neon-config
  3. .\" Author:
  4. .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
  5. .\" Date: 21 January 2023
  6. .\" Manual: neon API reference
  7. .\" Source: neon 0.32.5
  8. .\" Language: English
  9. .\"
  10. .TH "NEON\-CONFIG" "1" "21 January 2023" "neon 0.32.5" "neon API reference"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. neon-config \- script providing information about installed copy of neon library
  32. .SH "SYNOPSIS"
  33. .HP \w'\fBneon\-config\fR\ 'u
  34. \fBneon\-config\fR [\fB\-\-prefix\fR] [[\fB\-\-cflags\fR] | [\fB\-\-libs\fR] | [\fB\-\-la\-file\fR] | [\fB\-\-support\fR\ \fIfeature\fR] | [\fB\-\-help\fR] | [\fB\-\-version\fR]]
  35. .SH "DESCRIPTION"
  36. .PP
  37. The
  38. \fBneon\-config\fR
  39. script provides information about an installed copy of the neon library\&. The
  40. \fB\-\-cflags\fR
  41. and
  42. \fB\-\-libs\fR
  43. options instruct how to compile and link an application against the library; the
  44. \fB\-\-version\fR
  45. and
  46. \fB\-\-support\fR
  47. options can help determine whether the library meets the applications requirements\&.
  48. .SH "OPTIONS"
  49. .PP
  50. \fB\-\-cflags\fR
  51. .RS 4
  52. Print the flags which should be passed to the C compiler when compiling object files, when the object files use neon header files\&.
  53. .RE
  54. .PP
  55. \fB\-\-libs\fR
  56. .RS 4
  57. Print the flags which should be passed to the linker when linking an application which uses the neon library
  58. .RE
  59. .PP
  60. \fB\-\-la\-file\fR
  61. .RS 4
  62. Print the location of the libtool library script,
  63. libneon\&.la, which can be used to link against neon by applications using libtool\&.
  64. .RE
  65. .PP
  66. \fB\-\-version\fR
  67. .RS 4
  68. Print the version of the library
  69. .RE
  70. .PP
  71. \fB\-\-prefix\fR \fIdir\fR
  72. .RS 4
  73. If
  74. \fIdir\fR
  75. is given; relocate output of
  76. \fB\-\-cflags\fR
  77. and
  78. \fB\-\-libs\fR
  79. as if neon was installed in given prefix directory\&. Otherwise, print the installation prefix of the library\&.
  80. .RE
  81. .PP
  82. \fB\-\-support\fR \fIfeature\fR
  83. .RS 4
  84. The script exits with success if
  85. \fIfeature\fR
  86. is supported by the library\&.
  87. .RE
  88. .PP
  89. \fB\-\-help\fR
  90. .RS 4
  91. Print help message; includes list of known features and whether they are supported or not\&.
  92. .RE
  93. .SH "EXAMPLE"
  94. .PP
  95. Below is a Makefile fragment which could be used to build an application against an installed neon library, when the
  96. \fBneon\-config\fR
  97. script can be found in
  98. \fB$PATH\fR\&.
  99. .sp
  100. .if n \{\
  101. .RS 4
  102. .\}
  103. .nf
  104. CFLAGS = `neon\-config \-\-cflags`
  105. LIBS = `neon\-config \-\-libs`
  106. OBJECTS = myapp\&.o
  107. TARGET = myapp
  108. $(TARGET): $(OBJECTS)
  109. $(CC) $(LDFLAGS) \-o $(TARGET) $(OBJECTS) $(LIBS)
  110. myapp\&.o: myapp\&.c
  111. $(CC) $(CFLAGS) \-c myapp\&.c \-o myapp\&.o
  112. .fi
  113. .if n \{\
  114. .RE
  115. .\}
  116. .SH "AUTHOR"
  117. .PP
  118. \fBJoe Orton\fR
  119. .RS 4
  120. Author.
  121. .RE
  122. .SH "COPYRIGHT"
  123. .br