irony-server(1)

πŸ“¦
version 1.6.1 Β· 4 versions
, in ubuntu resolute, ubuntu stonking

πŸŽ€ irony-server β€” the manual, but make it make sense πŸŽ€

okay bestie, so <rainbow>irony-server</rainbow> is a thing that exists in the General Commands Manual and we're gonna talk about it. Sit down, hydrate, this one's cute actually.


✨ Name ✨

irony-server β€” the back-end server for Emacs irony-mode. that's it, that's the whole vibe. πŸ‘‘


✨ Synopsis ✨

irony-server [options] [command] [<args>]

like... that's the shape of it. options, then a command, then whatever args that command is hungry for. πŸ“


✨ Description ✨

so irony-server is the one that hands the libclang interface over to irony-mode. it talks in a simple protocol based on S-expression β€” very demure, very lisp-coded of it. πŸ’…

it's written in C++, main character language, no notes. and it needs a couple of packages already installed on your system to do its little thing:

  • CMake >= 2.8.3
  • libclang

no cap, if those aren't there, it's not gonna go. 🧚


✨ Options ✨

  • -v, --version β€” show the version and then immediately dip. ✌️
  • -h, --help β€” show a more detailed command help. like, the extra-detailed one. πŸ“–
  • -i, --interactive β€” run an interactive command loop. it ONLY accepts the Commands listed below, so don't get creative. this is primarily a machine interface that you (a human) interact with through irony.el, bestie. you're not really supposed to hand-feed it. πŸ€–
  • -d, --debug β€” write debug info to the log file. messy but make it documented. πŸ›
  • --log-file PATH β€” write logs to PATH instead of to standard error. redirect your drama, queen. πŸ“

✨ Commands ✨

  • candidates PREFIX STYLE β€” print completion candidates (requires a previous complete first, so do the homework). STYLE is "exact", "case-insensitive" or "smart-case". 🎯
  • complete FILE LINE COL [-- [COMPILE_OPTIONS...]] β€” perform code completion at a given location. ✨
  • completion-diagnostics β€” print the diagnostics that got generated during complete. the receipts. 🧾
  • diagnostics β€” print the diagnostics of the last parse. 🩺
  • exit β€” exit interactive mode, print absolutely nothing. silent, mysterious, iconic. πŸ’€
  • get-compile-options BUILD_DIR FILE β€” get compile options for FILE from the JSON database in PROJECT_ROOT. πŸ”
  • get-type LINE COL β€” get the type of the symbol at a given location. what IS that thing. πŸ¦‹
  • help β€” show this message. hi again. πŸ‘‹
  • parse FILE [-- [COMPILE_OPTIONS...]] β€” parse the given file. 🧠
  • reset-unsaved FILE β€” reset FILE, its content is up to date. fresh start, no baggage. 🌸
  • set-debug [on|off] β€” enable or disable verbose logging. toggle girlie. πŸ”₯
  • set-unsaved FILE UNSAVED-CONTENT-FILE β€” tell irony-server that UNSAVED-CONTENT-FILE contains the effective content of FILE. keeping it in the loop, respectfully. πŸ’œ

✨ Author ✨

Nicholas D Steeves <nsteeves@gmail.com> β€” the loml for real, tysm for this ✨🫢


ok be honest, you skimmed the middle. go back and read the --interactive one, it's lowkey important. πŸ’–

and that's the whole page, bestie β€” version 1.2.0, dated 2017-10-01, part of the irony-server(1) manual fam. slay, go write some C++, mwah πŸŽ€πŸŒˆπŸ‘‘

πŸ“¦ where this page comes from