Devuan fork of gpsd
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

77 lines
2.7 KiB

  1. '\" t
  2. .\" Title: libgpsmm
  3. .\" Author: [see the "AUTHOR" section]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
  5. .\" Date: 13 May 2005
  6. .\" Manual: GPSD Documentation
  7. .\" Source: The GPSD Project
  8. .\" Language: English
  9. .\"
  10. .TH "LIBGPSMM" "3" "13 May 2005" "The GPSD Project" "GPSD Documentation"
  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. libgpsmm, libQgpsmm \- C++ and QT class wrapper for the GPS daemon
  32. .SH "SYNOPSIS"
  33. .sp
  34. .ft B
  35. .nf
  36. C++:
  37. #include <libgpsmm>
  38. .fi
  39. .ft
  40. .HP \w'struct\ gps_data_t\ *open('u
  41. .BI "struct gps_data_t *open(char\ *" "host" ", char\ *" "port" ");"
  42. .HP \w'struct\ gps_data_t\ *open('u
  43. .BI "struct gps_data_t *open(void);"
  44. .HP \w'struct\ gps_data_t\ *send('u
  45. .BI "struct gps_data_t *send(char\ *" "request" ");"
  46. .HP \w'struct\ gps_data_t\ *read('u
  47. .BI "struct gps_data_t *read(void);"
  48. .HP \w'struct\ gps_data_t\ *waiting('u
  49. .BI "struct gps_data_t *waiting(int);"
  50. .HP \w'struct\ gps_data_t\ *stream('u
  51. .BI "struct gps_data_t *stream(unsigned\ int" "flags" ");"
  52. .SH "DESCRIPTION"
  53. .PP
  54. \fBlibgpsmm and libQgpsmm\fR
  55. are mere wrappers over
  56. \fBlibgps\fR\&. The important difference between the libraries is that libgpsmm is targeted at C++ applications and contained in
  57. \fBlibgps\fR, while libQgpsmm is platform independent by using QTcpSocket to connect to
  58. \fBgpsd\fR
  59. and shipped as an additional library due to the necessary linking to QT\&. Method names are the same as the analogue C functions\&. For a detailed description of the functions please read
  60. \fBlibgps\fR(3)\&.
  61. \fBopen()\fR
  62. must be called after class constructor and before any other method (\fBopen()\fR
  63. is not inside the constructor since it may fail, however constructors have no return value)\&. The analogue of the C function
  64. \fBgps_close()\fR
  65. is in the destructor\&.
  66. .SH "SEE ALSO"
  67. .PP
  68. \fBgpsd\fR(8),
  69. \fBgps\fR(1),
  70. \fBlibgps\fR(3)\&.
  71. .SH "AUTHOR"
  72. .PP
  73. Alfredo Pironti <alfredio@users\&.sourceforge\&.net>\&.