lyxclient(1) [suse man page]

LYXCLIENT(1)							  lyxclient 1.6.5						      LYXCLIENT(1)

NAME

       lyxclient - send commands to a running LyX editor

SYNOPSIS

       lyxclient [ options ]

DESCRIPTION

       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.

       -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.

       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.

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.

       -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.

       If neither -c nor -g are used, lyxclient will regard any standard input as commands to be sent to LyX, printing LyX's responses to standard
       output. Commands are separated by newlines (the '
' character). To finish communication and terminate the lyxclient process, send the com-
       mand 'BYE:'.

MISCELANEOUS OPTIONS

       -n name
	     when starting communication, lyxclient sends an idenfifier string to LyX. By default, this string is "PPID>PID", where PPID  is  lyx-
	     client's parent pid and pid is lyxclient's pid.  Use this option to override this default.

       -h    print the lyxclient version and summarize its usage.

ENVIRONMENT

       LYXSOCKET
	      can be used to specify the socket special file that must be used.  LyX sets this variable.  It is overridden by the -a option.

SEE ALSO

       lyx(1), xdvi(1), LFUNs.lyx.

AUTHORS

       Joao Luis M. Assirati <assirati@fma.if.usp.br> is the principal author of lyxclient.

Version 1.6.5							    2009-12-05							      LYXCLIENT(1)

LYX(1)								     LyX 1.6.5								    LYX(1)

NAME

       LyX - A Document Processor

SYNOPSIS

       lyx [ command-line switches ] [ name[.lyx] ... ]

DESCRIPTION

       LyX is too complex to be described completely in the "man" page format. If your system is properly configured, you can access the full doc-
       umentation within LyX under the Help menu.

       LyX is a document preparation system. It excels at  letting  you  create  complex  technical  and  scientific  articles	with  mathematics,
       cross-references,  bibliographies,  indices,  etc.  It  is very good at documents of any length in which the usual processing abilities are
       required: automatic sectioning and pagination, spellchecking, and so forth. It can also be used to write  a  letter  to	your  mom,  though
       granted, there are probably simpler programs available for that. It is definitely not the best tool for creating banners, flyers, or adver-
       tisements, though with some effort all these can be done, too.  Some examples of what it is used for:  memos,  letters,	dissertations  and
       theses, lecture notes, seminar notebooks, conference proceedings, software documentation, books (on PostgreSQL, remote sensing, cryptology,
       fictional novels, poetry, and even a children's book or two), articles in refereed scientific journals, scripts for plays and movies, busi-
       ness proposals... you get the idea.

       Currently,  LyX uses the Qt4 library as a toolkit. LyX should run everywhere, where this library runs.  This is on all major Unix platforms
       as well as Windows and Mac OS X (which actually is a unix platform).

OPTIONS

       LyX supports the following command-line switches.

       -help summarizes LyX usage

       -version
	     provides version information on the build of LyX.

       -sysdir directory
	     sets system directory. Normally not needed.

       -userdir directory
	     sets user directory. Needed if you want to use LyX with different lyxrc settings.

       -geometry WxH+X+Y
	     set geometry of the main window.

       -dbg feature[,feature...]
	     where feature is a name or number.  Use "lyx -dbg" to see the list of available debug features.

	-x [--execute] command
	     where command is a lyx command.

	-e [--export] fmt
	     where fmt is the export format of choice.	Look on Tools->Preferences->File formats->Format to get an idea which parameters should be
	     passed.

	-i [--import] fmt file.xxx
	     where fmt is the import format of choice and file.xxx is the file to be imported.

ENVIRONMENT

       LYX_DIR_16x
	      can be used to specify which system directory to use.

       The system directory is determined by searching for the file "chkconfig.ltx". Directories are searched in this order:
       1) -sysdir command line parameter
       2) LYX_DIR_16x environment variable
       3) Maybe <path of binary>/TOP_SRCDIR/lib
       4) <path of binary>/../share/<name of binary>/
       5) hardcoded lyx_dir (at build time: /usr/share/lyx)

       LYX_USERDIR_16x
	      can be used to specify which user directory to use.

       The user directory is, in order of precedence:
       1) -userdir command line parameter
       2) LYX_USERDIR_16x environment variable
       3) $HOME/.<name of binary> if no explicit setting is made

       LYX_LOCALEDIR
	      can be used to tell LyX where to look for the translations of its GUI strings in other languages.

FILES

       ~/.lyx/preferences      Personal configuration file
       ~/.lyx/lyxrc.defaults   Personal autodetected configuration file
       LIBDIR/lyxrc.dist  System wide configuration file
       LIBDIR/configure.py  Updates LyX if config has changed
       LIBDIR/bind/	 Keybindings
       LIBDIR/clipart/	 Clipart pictures
       LIBDIR/doc/	 Documentation in LyX format.
       LIBDIR/examples/  Example documents
       LIBDIR/images/	 Images used as icons or in popups
       LIBDIR/kbd/	 Keyboard mappings
       LIBDIR/layouts/	 Layout descriptions
       LIBDIR/templates/ Templates for documents
       LIBDIR/tex/	 Extra TeX files

       LIBDIR is the system directory. This was at build time /usr/share/lyx.

SEE ALSO

       tex2lyx(1), latex(1).

       Full documentation in either native LyX or postscript format.

BUGS
/LIMITATIONS
       There  are  still some bugs in LyX. To report one, read if possible the Introduction found under the Help menu in LyX. You'll find detailed
       info on submitting bug reports there. If you can't do that, send details to the LyX Developers mailing list lyx-devel@lists.lyx.org, or use
       the LyX bug tracker at http://bugzilla.lyx.org/. Don't forget to mention which version you are having problems with!

       LaTeX import is still not perfect and may produce buggy *.lyx files. Consult the tex2lyx documentation.

AUTHORS

       LyX is Copyright (C) 1995 by Matthias Ettrich, 1995-2009 LyX Team

Version 1.6.5							    2009-12-05								    LYX(1)