XCSoar

Contents:

• Compiling XCSoar
  • The Build System
  • Compiling XCSoar on Linux
• Setting up a development environment based on linux
  • Download source code
  • Setting up the build environment
  • Raspberry Pi
  • Optional: modern LaTeX editor for editing the Manual
• Rebranding XCSoar
  • Quick Start
  • Product Name Macros
  • Platform-Specific Paths
  • Files Using Product Name
  • What Needs Manual Changes
  • Usage Examples
  • Comparison with Other Forks
  • Testing Checklist
  • Advanced Customization
  • Contributing Improvements
  • Frequently Asked Questions
• Policy
  • Git Work Flow
  • Writing Patches
  • Code Style
  • C++
  • Graphical User Interface
• Release process
  • Version files
  • Preparing a minor release
  • Tagging and publication
  • Starting the next development cycle
  • Patch releases
• Architecture
  • Source Organisation
  • Threads and Locking
  • Accessing Sensor Data
  • Developing
  • User interface guidelines
• Weather overlay integration
  • Scope
  • Ownership model
  • Lifecycle in PageActions
  • Per-page cursor state
  • SkySight forecast loading
  • Threading and async boundaries
  • Integration checklist for a new provider
  • Common pitfalls
  • Page placement UX
• XCSoar data directory
  • Typed layout (XCSoar 7.45+)
  • Data root location
  • Directory layout overview
  • Typed subdirectories
  • Files in the data root
  • Profile paths
  • Upgrading from a flat layout
  • Related documentation
• Input Events
  • Overview
  • Default configuration
  • File format
  • Event execution order
  • Event list
  • Modes
  • Keys
  • Glide Computer Events
  • NMEA / hardware events
• Internationalisation (gettext)
  • Marking strings in source
  • Updating catalogues
  • Filling translations
  • Commit organisation
  • .po syntax notes
  • Related files
• Lua Scripting
  • Learning Lua
  • Running Lua
  • Lua Standard Libraries
  • XCSoar’s Lua API
• Map Data file formats
  • Map information
  • Terrain data files
  • Airspace
  • Waypoints
  • Topography data
• Task file format (.tsk)
  • Document structure
  • <Task>
  • <Point>
  • <Waypoint> and <Location>
  • <ObservationZone>
  • Load rules
  • What this format does not carry
  • A complete example
  • Testing a converter
• Checklists
  • File Location
  • File Format
  • Markdown Formatting
  • Links
  • Example Checklist
  • Supported URI Schemes
  • Keyboard Navigation
  • Tips
• Debugging Tips
  • Overview
  • Built-in replay and simulator
  • Replaying NMEA into a running XCSoar
  • Device and port debugging
  • Component testing with Run* utilities
  • Lua scripting and automated replay
  • GNU debugger (gdb)
  • Redraw counter overlay (e-ink)
  • Force all map overlays
  • iOS and macOS
• Test and Debug Utilities
  • Overview
  • Building Run* Utilities
  • Common Patterns
  • Using DebugReplay
  • Common Utility Examples
  • Data Conversion Utilities
  • Flight Analysis Utilities
  • Device and Port Utilities
  • LXNAV polar sync — manual XCSoar checklist (#2397)
  • Scripting Utilities
  • Renderer Utilities
  • Creating a New Run* Utility
  • Dependencies
  • Additional Resources
• Git Tips and Tricks
  • Interactive Rebase
  • Fixup Commits
  • Useful One-Liners
  • Visual Tools
  • Common Workflows
  • Tips
  • Additional Resources

Build system reference: Graphics Backends by Target

Developer docs: Compiling XCSoar (Development workflow), Test and Debug Utilities

Indices and tables

• Index

• Module Index

• Search Page