Manual Reference Pages - LYXCLIENT (1)
lyxclient - send commands to a running LyX editor
Server Identification Options
Command Mode Options
lyxclient [ options ]
When LyX starts, it creates a unique, per-process local socket in the
temporary directory through which commands can be sent. That is, it can act
like a server, accepting connections from clients. lyxclient
can be used as such client. lyxclient will take care of all
connection and communication protocol details, leaving you (or your app)
free to concentrate on what you want to send to LyX.
SERVER IDENTIFICATION OPTIONS
lyxclient must first identify to which server (i.e. a running LyX)
commands are to be sent. The following options are used to specify the server.
If neither -a nor -p are invoked, lyxclient will search for
sockets in /tmp (or tmp_dir if the -t option is used) and use
the first socket to which it can connect.
This is safe if you are running only one LyX process at any one time.
-p pid ||
specify the pid of the running LyX process to which lyxclient
should send commands.
-a socket_address |
specify explicitly which socket special file should be used. These special
files are located inside lyx_tmpdir<lyx_pid><hash>, in the temporary
directory. There is one per running LyX process.
-t tmp_dir |
if LyX is configured to use a temporary directory other than /tmp, you must
inform lyxclient of this.
COMMAND MODE OPTIONS
lyxclient can send commands to LyX from both the command-line
and from standard input.
LyX commands documentation can be found in LyX Help menu.
If neither -c nor -g are used, lyxclient will regard any
standard input as commands to be sent to LyX, printing LyXs responses to
standard output. Commands are
separated by newlines (the \n character). To finish communication
and terminate the lyxclient process, send the command BYE:.
-c command |
send a single command, print LyX information to standard output and exit. LYXCMD prefix is needed in the given command.
-g file line |
this is simply a wrapper for the command server-goto-file-row file line. It is used by the DVI previewer to elicit inverse DVI search.
-n name ||
when starting communication, lyxclient sends an idenfifier
string to LyX. By default, this string is "PPID>PID", where PPID is
lyxclients parent pid and pid is lyxclients pid.
Use this option to override this default.
print the lyxclient version and summarize its usage.
can be used to specify the socket special file that must be used.
LyX sets this variable.
It is overridden by the -a option.
lyx(1), xdvi(1), LFUNs.lyx.
Jo[~a]o Luis M. Assirati <email@example.com> is the principal author
|Version 2.1.4 ||LYXCLIENT (1) ||2015-07-24 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.