opencpn.1 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. .\"
  2. .\" (C) Copyright 2018 Alec Leamas <leamas.alec@gmail.com>,
  3. .\"
  4. .TH Opencpn 1 "July 2018"
  5. .SH NAME
  6. opencpn \- Chartplotter and GPS Navigation Software
  7. .SH SYNOPSIS
  8. .B opencpn
  9. .RI [ options ]
  10. .SH DESCRIPTION
  11. OpenCPN is a chartplotter and navigation GUI program supporting navigation
  12. under way as well as planning. It supports a wide range of chart formats
  13. using a plugin system. Other plugins provides support for e. g. radar, AIS
  14. and weather maps. Program is localized in 20+ languages and ported to
  15. several OS including MacOS, Windows and Linux.
  16. .SH OPTIONS FOR STARTING OPENCPN
  17. .TP
  18. .B \-h, \-\-help
  19. Show help info.
  20. .TP
  21. .B \-p, \-\-portable
  22. Run in portable mode.
  23. .TP
  24. .B \-l, \-\-loglevel=<level>
  25. Set amount of logged information. Level is any of \fItrace\fR,
  26. \fIdebug\fR, \fIinfo\fR, \fImessage\fR, \fIwarning\fR or \fIerror\fR,
  27. defaulting to \fIinfo\fR if not set in environment; see ENVIRONMENT.
  28. .TP
  29. .B \-c, \-\-configdir=<directory>
  30. Use alternative configuration directory instead of \fI~/.openpcn\fR on
  31. Linux or MacOS.
  32. .B \-f, \-\-fullscreen
  33. Switch to full screen mode on start.
  34. .TP
  35. .B \-G, \-\-no_opengl
  36. Disable OpenGL video acceleration. This setting will be remembered.
  37. .TP
  38. .B \-g, \-\-rebuild_gl_raster_cache
  39. Rebuild OpenGL raster cache on start.
  40. .TP
  41. .B \-D, \-\-rebuild_chart_db
  42. Rescan chart directories and rebuild the chart database
  43. .TP
  44. .B \-P, \-\-parse_all_enc
  45. Convert all S-57 charts to OpenCPN's internal format on start.
  46. .TP
  47. .B \-u, \-\-unit_test_1:<num>
  48. Display a slideshow of <num> charts and then exit. Zero or negative <num>
  49. specifies no limit.
  50. .TP
  51. .B \-s, \-\-safe_mode
  52. Run without plugins, openGL and other possibly problematic features.
  53. It is still possible to unintall plugins in this mode.
  54. .SH OPTIONS FOR MANIPULATING RUNNING OPENCPN
  55. .TP
  56. .B \-r, \-\-remote
  57. Run commands on a running instance instead of starting opencpn. Exits with
  58. error code if no running opencpn instance is found.
  59. .TP
  60. .B \-R, \-\-raise
  61. Raise opencpn window to be on top of other windows, requires \-\-remote.
  62. This is the default behaviour if opencpn is invoked without options and
  63. arguments and there already is a running instance.
  64. .TP
  65. .B \-e, \-\-get_rest_endpoint
  66. Print the url for connecting to the local opencpn REST server e. g.
  67. http://localhost:8000. Requires \-\-remote.
  68. .TP
  69. .B \-q, \-\-quit
  70. Make the remote instance exit. Requires \-\-remote.
  71. .SH PLUGIN LOADING
  72. Plugin loading depends on that the opencpn main program can locate the
  73. plugin object file and that the plugin can locate it's own data.
  74. .P
  75. On Linux, the main program searches for plugin .so-files in two locatiosn.
  76. The first is \fI~/.local/lib/opencpn\fR.
  77. The second is \fI@install-dir@/../lib/opencpn\fR where \fI@install-dir@\fR
  78. is the location where opencpn is installed.
  79. If for example opencpn is installed in \fI/usr/bin\fR plugins will be loaded
  80. from \fI/usr/lib/opencpn\fR.
  81. .P
  82. On other platforms plugins are also loaded from two different locations,
  83. one of which used primarely for system plugins and requiring administrative
  84. privileges.
  85. The other is a user-writable locations used by the plugin manager.
  86. .P
  87. A plugin's data directory is a path ending with
  88. \fIopencpn/plugins/<plugin_name>\fR.
  89. On Linux, this is by default searched in
  90. ~/.local/share:/usr/local/share:/usr/share.
  91. This search path is overridden by XDG_DATA_DIRS as defined by the freedesktop
  92. spec.
  93. Only plugins adapted for this (i. e., using GetPluginDataDir()) handles this
  94. properly.
  95. .P
  96. On other platforms plugin data directories are located in similar locations
  97. which also must be retrieved in runtime using GetPluginDataDir().
  98. .SH LIBRARY LOADING AND LD_LIBRARY_PATH
  99. If \fILD_LIBRARY_PATH\fR exists in the environment \fBopencpn\fR uses it
  100. without modifications.
  101. .P
  102. Otherwise \fILD_LIBRARY_PATH\fR is set to the same path as from which plugins are
  103. loaded, see above. This ensures that helper binaries can load possible libraries
  104. installed in the same directories as the plugin.
  105. .SH ENVIRONMENT
  106. .TP
  107. .B OPENCPN_PLUGIN_DIRS
  108. Plugin load path, see PLUGIN LOADING. If existing, overrides all default entries.
  109. The path is ';'-separated on Windows but uses ':' on other platforms.
  110. .TP
  111. .B OPENCPN_LOGLEVEL
  112. Default loglevel if not defined on command line using -l/--loglevel. See
  113. the --loglevel option for allowed values.
  114. .TP
  115. .B OPENCPN_FATAL_ERROR
  116. If defined, displays the message and exits on startup.
  117. .SH FILES
  118. .TP
  119. .B ~/.opencpn/opencpn.log
  120. System log file, a useful tool to solve problems.
  121. .SH SEE ALSO
  122. .br
  123. https://www.opencpn.org
  124. .br
  125. https://www.freedesktop.org
  126. .br
  127. https://opencpn-manuals.github.io/main