1LYXCLIENT(1) lyxclient 2.3.7 LYXCLIENT(1)
2
6 lyxclient - send commands to a running LyX editor
7
9 lyxclient [ options ]
10
12 When LyX starts, it creates a unique, per-process local socket in the
13 temporary directory through which commands can be sent. That is, it can
14 act like a server, accepting connections from clients. lyxclient can be
15 used as such client. lyxclient will take care of all connection and
16 communication protocol details, leaving you (or your app) free to con‐
17 centrate on what you want to send to LyX.
18
20 lyxclient must first identify to which server (i.e. a running LyX) com‐
21 mands are to be sent. The following options are used to specify the
22 server.
23 -p pid
26 specify the pid of the running LyX process to which lyxclient
27 should send commands.
28 -a socket_address
30 specify explicitly which socket special file should be used.
31 These special files are located inside lyx_tmpdir<lyx_pid><hash>,
32 in the temporary directory. There is one per running LyX process.
33 -t tmp_dir
35 if LyX is configured to use a temporary directory other than
36 /tmp, you must inform lyxclient of this.
37 If neither -a nor -p are invoked, lyxclient will search for sockets in
39 /tmp (or tmp_dir if the -t option is used) and use the first socket to
40 which it can connect. This is safe if you are running only one LyX
41 process at any one time.
42
44 lyxclient can send commands to LyX from both the command-line and from
45 standard input. LyX commands documentation can be found in LyX Help
46 menu.
47 -c command
49 send a single command, print LyX information to standard output
50 and exit. LYXCMD prefix is needed in the given command.
51 -g file line
53 this is simply a wrapper for the command 'command-sequence
54 server-goto-file-row file line; lyx-activate'. It is used by the
55 PDF and DVI previewer to elicit inverse search and focus the LyX
56 window.
57 If neither -c nor -g are used, lyxclient will regard any standard input
59 as commands to be sent to LyX, printing LyX's responses to standard
60 output. Commands are separated by newlines (the '\n' character). To
61 finish communication and terminate the lyxclient process, send the com‐
62 mand 'BYE:'.
63
65 -n name
66 when starting communication, lyxclient sends an idenfifier string
67 to LyX. By default, this string is "PPID>PID", where PPID is lyx‐
68 client's parent pid and pid is lyxclient's pid. Use this option
69 to override this default.
70 -h print the lyxclient version and summarize its usage.
72
74 LYXSOCKET
75 can be used to specify the socket special file that must be
76 used. LyX sets this variable. It is overridden by the -a op‐
77 tion.
78
80 lyx(1), xdvi(1), LFUNs.lyx.
81
83 João Luis M. Assirati <assirati@fma.if.usp.br> is the principal author
84 of lyxclient.
85Version 2.3.7 2023-01-01 LYXCLIENT(1)