doc/geany.1.in

   1 .TH "GEANY" "1" "October 09, 2021" "geany @VERSION@" ""
   2 .SH "NAME"
   3 Geany \(em a small and lightweight IDE
   4 .SH "SYNOPSIS"
   5 .PP
   6 \fBgeany\fR [\fBoption\fP]  [\fP+number\fP]  [\fBfiles ...\fP]
   7 .SH "DESCRIPTION"
   8 .PP
   9 Geany is a small and fast editor with basic features of an integrated development environment.
  10 .PP
  11 Some of its features: syntax highlighting, code completion, code folding, symbol/tag lists and
  12 many supported filetypes like C(++), Java, PHP, HTML, DocBook, Perl and more.
  13 .PP
  14 Homepage: https://www.geany.org/
  15 .SH "OPTIONS"
  16 .IP "\fB\fP    \fBfiles ...\fP         " 10
  17 A space-separated list of filenames. Absolute and relative filenames can be used. Geany also
  18 recognises line and column information when appended to the filename with colons, e.g.
  19 "geany foo.bar:10:5" will open the file foo.bar and place the cursor in line 10 at column 5.
  20 .IP "\fB\fP    \fB\fP         " 10
  21 Projects can also be opened but a project file (*.geany) must be the first non-option argument.
  22 All additionally given files are ignored.
  23 .IP "\fB\fP    \fB\+number\fP         " 10
  24 Set initial line
  25 .I number
  26 for the first opened file (same as \-\-line, do not put a space
  27 between the + sign and the number). E.g. "geany +7 foo.bar" will open the file foo.bar and
  28 place the cursor in line 7.
  29 .IP "\fB\fP    \fB\-\-column\fP         " 10
  30 Set initial column number for the first opened file (useful in conjunction with \-\-line).
  31 .IP "\fB-c\fP, \fB\-\-config\fP         " 10
  32 Use an alternate configuration directory. Default configuration directory is
  33 ~/.config/geany/ and there resides geany.conf and some template files.
  34 .IP "\fB\fP    \fB\-\-ft\-names\fP         " 10
  35 Print a list of Geany's internal filetype names (useful snippets configuration).
  36 .IP "\fB-g\fP, \fB\-\-generate\-tags\fP         " 10
  37 Generate a global tags file (see documentation).
  38 .IP "\fB-P\fP, \fB\-\-no\-preprocessing\fP         " 10
  39 Don't preprocess C/C++ files when generating tags.
  40 .IP "\fB-i\fP, \fB\-\-new-instance\fP         " 10
  41 Don't open files in a running instance, force opening a new instance.
  42 Only available if Geany was compiled with support for Sockets.
  43 .IP "\fB-l\fP, \fB\-\-line\fP         " 10
  44 Set initial line number for the first opened file.
  45 .IP "\fB\fP    \fB\-\-list\-documents\fP         " 10
  46 Return a list of open documents in a running Geany instance.
  47 This can be used to read the currently opened documents in Geany from an external script
  48 or tool. The returned list is separated by newlines (LF) and consists of the full,
  49 UTF\-8 encoded filenames of the documents.
  50 Only available if Geany was compiled with support for Sockets.
  51 .IP "\fB-m\fP, \fB\-\-no-msgwin\fP         " 10
  52 Don't show the message window. Use this option if you don't need compiler messages
  53 or VTE support.
  54 .IP "\fB-n\fP, \fB\-\-no-ctags\fP         " 10
  55 Don't load symbol completion and call tip data. Use this option, if you don't want to use them.
  56 For more information please see documentation.
  57 .IP "\fB-p\fP, \fB\-\-no-plugins\fP         " 10
  58 Don't load plugin support.
  59 .IP "\fB\fP    \fB\-\-print-prefix\fP         " 10
  60 Print installation prefix, the data directory, the lib directory and the locale directory (in
  61 this order) to stdout, each per line. This is mainly intended for plugin authors to detect
  62 installation paths.
  63 .IP "\fB-r\fP, \fB\-\-read-only\fP         " 10
  64 Open all files given on the command line in read-only mode. This only applies to files
  65 opened explicitly from the command line, so files from previous sessions or project
  66 files are unaffected.
  67 .IP "\fB-s\fP, \fB\-\-no-session\fP         " 10
  68 Don't load the previous session's files.
  69 .IP "\fB-t\fP, \fB\-\-no-terminal\fP         " 10
  70 Don't load terminal support. Use this option, if you don't want to load the virtual terminal
  71 emulator widget at startup. If you don't have libvte.so.4 installed, then terminal-support is
  72 automatically disabled. Only available if Geany was compiled with support for VTE.
  73 .IP "\fB\fP    \fB\-\-socket-file\fP         " 10
  74 Use this socket filename for communication with a running Geany instance
  75 .IP "\fB\fP    \fB\-\-vte-lib\fP         " 10
  76 Specify explicitly the path including filename or only the filename to the VTE library, e.g.
  77 /usr/lib/libvte.so or libvte.so. This option is only needed, when the autodetection doesn't
  78 work. Only available if Geany was compiled with support for VTE.
  79 .IP "\fB-v\fP, \fB\-\-verbose\fP         " 10
  80 Be verbose (print useful status messages).
  81 .IP "\fB-V\fP, \fB\-\-version\fP         " 10
  82 Show version information and exit.
  83 .IP "\fB-?\fP, \fB\-\-help\fP         " 10
  84 Show help information and exit.
  85 .PP
  86 Geany supports all generic GTK options, a list is available on the help screen.
  87 .SH "AUTHOR"
  88 .PP
  89 This manual page was written by the Geany developer team. Permission is
  90 granted to copy, distribute and/or modify this document under
  91 the terms of the GNU General Public License, Version 2.
  92 .PP
  93 The complete text of the GNU General Public License can be found in @GEANY_DATA_DIR@/GPL-2.