ne_version_match.3 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. '\" t
  2. .\" Title: ne_version_match
  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 "NE_VERSION_MATCH" "3" "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. ne_version_match, ne_version_string \- library versioning
  32. .SH "SYNOPSIS"
  33. .sp
  34. .ft B
  35. .nf
  36. #include <ne_utils\&.h>
  37. .fi
  38. .ft
  39. .HP \w'int\ ne_version_match('u
  40. .BI "int ne_version_match(int\ " "major" ", int\ " "minor" ");"
  41. .HP \w'const\ char\ *ne_version_string('u
  42. .BI "const char *ne_version_string(void);"
  43. .SH "DESCRIPTION"
  44. .PP
  45. The
  46. \fBne_version_match\fR
  47. function returns non\-zero if the library version is not of major version
  48. \fImajor\fR, or the minor version is less than
  49. \fIminor\fR\&. For neon versions 0\&.x, every minor version is assumed to be incompatible with every other minor version\&.
  50. .PP
  51. The
  52. \fBne_version_string\fR
  53. function returns a string giving the library version\&.
  54. .SH "EXAMPLES"
  55. .PP
  56. To require neon 1\&.x, version 1\&.2 or later:
  57. .sp
  58. .if n \{\
  59. .RS 4
  60. .\}
  61. .nf
  62. if (ne_version_match(1, 2)) {
  63. printf("Library version out of date: 1\&.2 required, found %s\&.",
  64. ne_version_string());
  65. exit(1);
  66. }
  67. .fi
  68. .if n \{\
  69. .RE
  70. .\}
  71. .SH "AUTHOR"
  72. .PP
  73. \fBJoe Orton\fR
  74. .RS 4
  75. Author.
  76. .RE
  77. .SH "COPYRIGHT"
  78. .br