#LyX 2.1 created this file. For more info see http://www.lyx.org/
-\lyxformat 459
+\lyxformat 474
\begin_document
\begin_header
\textclass scrbook
\use_geometry false
\use_package amsmath 1
\use_package amssymb 1
+\use_package cancel 0
\use_package esint 0
\use_package mathdots 1
\use_package mathtools 0
\use_package stmaryrd 0
\use_package undertilde 0
\cite_engine basic
-\cite_engine_type numerical
+\cite_engine_type default
\biblio_style plain
\use_bibtopic false
\use_indices false
\end_layout
\begin_layout Subtitle
-Version 2.0.x
+Version 2.1.x
\end_layout
\begin_layout Author
\end_layout
\begin_layout Standard
-\begin_inset ERT
+\begin_inset Flex Multiple Columns
status open
-\begin_layout Plain Layout
-
-
-\backslash
-begin{multicols}{2}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Itemize
\family sans
Comment
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-end{multicols}
-\end_layout
-
\end_inset
\end_layout
\begin_layout Standard
-\begin_inset ERT
+\begin_inset Flex Multiple Columns
status open
-\begin_layout Plain Layout
-
-
-\backslash
-begin{multicols}{2}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Itemize
\family sans
Definition*
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-end{multicols}
-\end_layout
-
\end_inset
\end_layout
\begin_layout Standard
-\begin_inset ERT
+\begin_inset Flex Multiple Columns
status open
-\begin_layout Plain Layout
-
-
-\backslash
-begin{multicols}{2}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Itemize
\family sans
\end_layout
\begin_deeper
-\begin_layout Standard
+\begin_layout Plain Layout
\begin_inset space ~
\end_inset
\end_layout
\end_deeper
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-end{multicols}
-\end_layout
-
\end_inset
\family default
environments.
Again the only difference is the spacing between foilhead and body.
- Both of the short versions have 0.5 inches less separation between the foilhead
- and the body.
+ Both of the short versions have 0.5
+\begin_inset space ~
+\end_inset
+
+inches less separation between the foilhead and the body.
\end_layout
\end_layout
\begin_layout Standard
-LyX supports some of the most basic RCS/CVS/SVN commands.
+LyX supports some of the most basic RCS/CVS/SVN/GIT commands.
If you need something a bit more sophisticated you will have to do that
manually in a terminal.
\end_layout
\begin_layout Standard
Before you begin to use the version control features in LyX, you should
- be familiar with RCS/CVS/SVN usage.
+ be familiar with RCS/CVS/SVN/GIT usage.
The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
- package—no guarantees are made for older versions.
+ package — no guarantees are made for older versions.
Most of the log messages are not currently displayed after operations —
you can check them in the Messages pane if unsure.
Regular users of version control will appreciate VC toolbar, which can
This is stored in the history log.
The version number is bumped, your changes are applied to the master RCS
file, the document is unlocked and set to Read-Only mode.
-
\end_layout
\begin_layout Standard
You will usually continue editing for a while and when you are finished
you check in your changes.
The status line is changed to reflect that you have locked the file.
-
\end_layout
\begin_layout Standard
\begin_layout Subsubsection
+\family sans
+Copy
+\end_layout
+
+\begin_layout Standard
+This will create a copy of the current document.
+ Since RCS does not support copy operations natively, the version history
+ is not preserved, and the copy is added as a new file.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the copy operation.
+ After that the copy is created, both locally and in the repository.
+ If the parent directories of the copied and original document differ, all
+ relative paths of included files of the copy are adjusted (like in
+\family sans
+File\SpecialChar \menuseparator
+Save As
+\family default
+\SpecialChar \ldots{}
+).
+ Finally, the copy is loaded instead of the original document.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+RCS
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+Copy
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+ to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ci -q -u
+\family typewriter
+-i
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
\family sans
Undo Last Checkin
\end_layout
This makes as if the last check in never happened.
No changes are made to the document loaded into LyX, but the last version
is removed from the master RCS file.
-
\end_layout
\begin_layout Standard
rlog -r <file-name>
\family default
.
- For other details see
+ See
\begin_inset CommandInset ref
LatexCommand ref
reference "sub:VCS-Revision-Information"
If your documents are under revision control and others are using the same
repository problems arise when different changes to the same document at
the same location happen.
- Standard CVS repositories doesn't operate with a file locking mechanism.
+ Standard CVS repositories don't operate with a file locking mechanism.
This may be surprising, but conflicts only occur if people disagree on
the proper content of the same part of a document.
So, if co-workers are used to communicate regularly, these conflicts occur
\end_layout
\begin_layout Subsubsection
-Update of the local directory checkout from repository
+
+\family sans
+Copy
\end_layout
\begin_layout Standard
-Once your documents gets more complex, containing sub-documents and pictures,
- including external
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-.tex
+This will create a copy of the current document.
+ Since CVS does not support copy operations natively, the version history
+ is not preserved, and the copy is added as a new file.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the copy operation.
+ After that the copy is created, both locally and in the repository.
+ If the parent directories of the copied and original document differ, all
+ relative paths of included files of the copy are adjusted (like in
+\family sans
+File\SpecialChar \menuseparator
+Save As
+\family default
+\SpecialChar \ldots{}
+).
+ Finally, the copy is loaded instead of the original document.
\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
+\begin_inset space ~
\end_inset
- files and so on using version control becomes more complicated.
- LyX supports updating the whole tree in which resides the document.
- This become especially useful once you cooperate with people which neither
- have detailed knowledge about CVS usage nor they have ambition to commit
- additional material to the repository.
- You have to organize the files structure so that all external files are
- in the same directory or subdirectories of the document.
- It's good practice anyway to store multipart documents in an extra directory.
-\end_layout
-
-\begin_layout Standard
-The
-\begin_inset Flex Code
-status collapsed
+commands:
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-Update local directory from repository
-\end_layout
+\begin_inset Newline newline
\end_inset
- command updates the whole directory.
- If local changes are detected user is warned before update starts.
- In case of merge conflicts both versions of the conflicting document parts
- are placed in the final document.
- You have to review and correct the result of the merge.
- You'll find the conflicts enclosed in pairs of
+Copy
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<<<<<<<
-\end_layout
+\family typewriter
+\begin_inset Quotes eld
\end_inset
- and
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
->>>>>>>
-\end_layout
-
+<file-name>
+\begin_inset Quotes erd
\end_inset
- separated by
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-=======
\end_layout
\end_inset
-.
- The first part is your version as before the update operation with the
- document name prepended.
- The second one is the repository version with the version number after
- the sequence of
+ to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
->
-\end_layout
+\family typewriter
+\begin_inset Quotes eld
\end_inset
- signs.
-\end_layout
-
-\begin_layout Labeling
-\labelwidthstring 00.00.0000
-CVS
-\begin_inset space ~
+<new-file-name>
+\begin_inset Quotes erd
\end_inset
-commands:
-\begin_inset space ~
+
+\end_layout
+
\end_inset
status collapsed
\begin_layout Plain Layout
-cd $path; cvs diff
+cvs -q add
\family typewriter
-"."
-\end_layout
+\begin_inset Quotes eld
\end_inset
- (Ask if changes are detected.)
-\begin_inset Newline newline
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Rename
+\end_layout
+
+\begin_layout Standard
+This will rename the current document.
+ Since CVS does not support rename operations natively, the version history
+ is not preserved, the renamed document is added as a new file, and the
+ original document is deleted.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the rename operation.
+ After that the document is renamed, both locally and in the repository.
+ If the parent directories of the new and old file names differ, all relative
+ paths of included files are adjusted (like in
+\family sans
+File\SpecialChar \menuseparator
+Save As
+\family default
+\SpecialChar \ldots{}
+).
+ Finally, the document is reloaded using the new name.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+Rename
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+ to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs -q add
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs -q remove
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+Update of the local directory checkout from repository
+\end_layout
+
+\begin_layout Standard
+Once your documents gets more complex, containing sub-documents and pictures,
+ including external
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.tex
+\end_layout
+
+\end_inset
+
+ files and so on using version control becomes more complicated.
+ LyX supports updating the whole tree in which resides the document.
+ This become especially useful once you cooperate with people which neither
+ have detailed knowledge about CVS usage nor they have ambition to commit
+ additional material to the repository.
+ You have to organize the files structure so that all external files are
+ in the same directory or subdirectories of the document.
+ It's good practice anyway to store multipart documents in an extra directory.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Update local directory from repository
+\end_layout
+
+\end_inset
+
+ command updates the whole directory.
+ If local changes are detected user is warned before update starts.
+ In case of merge conflicts both versions of the conflicting document parts
+ are placed in the final document.
+ You have to review and correct the result of the merge.
+ You'll find the conflicts enclosed in pairs of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<<<<<<<
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+>>>>>>>
+\end_layout
+
+\end_inset
+
+ separated by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+=======
+\end_layout
+
+\end_inset
+
+.
+ The first part is your version as before the update operation with the
+ document name prepended.
+ The second one is the repository version with the version number after
+ the sequence of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+>
+\end_layout
+
+\end_inset
+
+ signs.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cd $path; cvs diff
+\family typewriter
+"."
+\end_layout
+
+\end_inset
+
+ (Ask if changes are detected.)
+\begin_inset Newline newline
\end_inset
is shown in a browser.
\end_layout
+\begin_layout Subsubsection
+Revision info
+\end_layout
+
+\begin_layout Standard
+LyX supports CVS version number, author name, date and time of last commit.
+ All those are extracted from
+\family typewriter
+cvs log -r <file-name>
+\family default
+.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:VCS-Revision-Information"
+
+\end_inset
+
+ for details.
+\end_layout
+
\begin_layout Subsection
SVN commands in LyX
\end_layout
egister
\family default
item is not visible.
-
\end_layout
\begin_layout Standard
\family default
file exists).
This means you have to checkout the archive by yourself.
-
\end_layout
\begin_layout Standard
man svn
\family default
to understand the switches.
-
\end_layout
\begin_layout Subsubsection
svn commit -q -m"<description>" <file-name>
\end_layout
-\begin_layout Subsubsection
+\begin_layout Subsubsection
+
+\family sans
+Check Out For Edit
+\end_layout
+
+\begin_layout Standard
+Updates the changes of this file from the repository.
+ Be sure you understand SVN merging and conflicts resolving before using
+ this function, because all conflicts has to be resolved manually by you!
+\end_layout
+
+\begin_layout Standard
+SVN command:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Ditto.
+\end_layout
+
+\end_inset
+
+
+\family typewriter
+svn update --non-interactive
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Revert To Repository Version
+\end_layout
+
+\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+\end_layout
+
+\begin_layout Standard
+SVN command:
+\family typewriter
+svn revert -q
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Copy
+\end_layout
+
+\begin_layout Standard
+This will create a copy of the current document including the version history.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the copy operation.
+ After that the copy is created, both locally and in the repository.
+ If the parent directories of the copied and original document differ, all
+ relative paths of included files of the copy are adjusted (like in
+\family sans
+File\SpecialChar \menuseparator
+Save As
+\family default
+\SpecialChar \ldots{}
+).
+ Finally, the copy is loaded instead of the original document.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+SVN
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn copy -q
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn commit
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Rename
+\end_layout
+
+\begin_layout Standard
+This will rename the current document including the version history.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the rename operation.
+ After that the document is renamed, both locally and in the repository.
+ If the parent directories of the new and old file names differ, all relative
+ paths of included files are adjusted (like in
+\family sans
+File\SpecialChar \menuseparator
+Save As
+\family default
+\SpecialChar \ldots{}
+).
+ Finally, the document is reloaded using the new name.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+SVN
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
-\family sans
-Check Out For Edit
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-Updates the changes of this file from the repository.
- Be sure you understand SVN merging and conflicts resolving before using
- this function, because all conflicts has to be resolved manually by you!
-\end_layout
-\begin_layout Standard
-SVN command:
-\begin_inset Foot
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Ditto.
-\end_layout
+svn move -q
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+<file-name>
+\begin_inset Quotes erd
\end_inset
-\family typewriter
-svn update --non-interactive
\begin_inset Quotes eld
\end_inset
-<file-name>
+<new-file-name>
\begin_inset Quotes erd
\end_inset
\end_layout
-\begin_layout Subsubsection
-
-\family sans
-Revert To Repository Version
-\end_layout
+\end_inset
-\begin_layout Standard
-This will discard all changes made to the document since the last check
- in.
- You get a warning before changes are discarded.
-
-\end_layout
-\begin_layout Standard
-SVN command:
-\family typewriter
-svn revert -q
-\begin_inset Quotes eld
+\begin_inset Newline newline
\end_inset
-<file-name>
-\begin_inset Quotes erd
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn commit
+\end_layout
+
\end_inset
\begin_inset Tabular
<lyxtabular version="3" rows="6" columns="2">
<features rotate="0" tabularvalignment="middle">
-<column alignment="center" valignment="top" width="0">
-<column alignment="center" valignment="top" width="0">
+<column alignment="center" valignment="top">
+<column alignment="center" valignment="top">
<row>
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
status collapsed
\begin_layout Plain Layout
-authorized_keys2
+authorized_keys2
+\end_layout
+
+\end_inset
+
+ file.
+\end_layout
+
+\begin_layout Enumerate
+Get the Putty's
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+plink
+\end_layout
+
+\end_inset
+
+.
+ In the SVN config file
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Exact path depends on Windows version, usually somewhere around
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+c:
+\backslash
+Documents and Settings
+\backslash
+user
+\backslash
+Application Data
+\backslash
+Subversion
+\backslash
+config
+\end_layout
+
+\end_inset
+
+ /
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AppData
+\backslash
+Roaming
+\backslash
+Subversion
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+, section [tunnels], setup ssh command, e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ssh=c:/path/plink.exe -i c:/path/private_key.ppk
+\end_layout
+
+\end_inset
+
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+It will usually take a lot of time to get exact command right and it depends
+ on many things.
+ For example do not have some remote server saved as a default session in
+ Putty etc.
+ If things fail, try to connect via plink without SVN first.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+Checkout the SVN archive, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn co svn+ssh://user@server/repository_path
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsubsection
+End-of-Line Conversions
+\end_layout
+
+\begin_layout Standard
+When the collaborators are mixing Linux and Windows environments, LyX will
+ use different line endings inside the .lyx files.
+ This is not a problem as far as LyX functionality is concerned, but the
+ commit diffs will be huge and merge-conflicts prone.
+ Fortunately SVN itself knows
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+ how to deal with CR/LF problems when switching .lyx files to the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+native
+\end_layout
+
+\end_inset
+
+ mode.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For the lazy guys:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn propset svn:eol-style native FILE_NAME
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+GIT commands in LyX
+\end_layout
+
+\begin_layout Standard
+A minimal subset of GIT commands is now supported by LyX.
+ You can find the commands in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
+\end_inset
+
+Control
+\family default
+ submenu.
+ Please note that if you use password protected access to repository via
+ ssh, you will be asked in terminal window.
+ LyX was tested against GIT 1.7.
+\end_layout
+
+\begin_layout Standard
+One big difference of GIT and the other supported version control systems
+ is the distributed nature of GIT: With traditional version control systems
+ there is one central server which hosts the repository.
+ Users commit their changes to the server, and get updates made by other
+ users from it.
+ With GIT, users commit to a local repository.
+ The local repository can be synchronized with one or more remote repositories
+ using the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+pull
\end_layout
\end_inset
- file.
-\end_layout
-
-\begin_layout Enumerate
-Get the Putty's
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-plink
+push
\end_layout
\end_inset
-.
- In the SVN config file
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-Exact path depends on Windows version, usually somewhere around
+ GIT commands.
+ LyX does not interact in any way with remote GIT repositories.
+ It works exclusively with the local repository in a very similar way as
+ with a central CVS or SVN repository.
+ If you use remote GIT repositories you need to do the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-c:
-\backslash
-Documents and Settings
-\backslash
-user
-\backslash
-Application Data
-\backslash
-Subversion
-\backslash
-config
+pull
\end_layout
\end_inset
- /
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AppData
-\backslash
-Roaming
-\backslash
-Subversion
+push
\end_layout
\end_inset
-.
+ operations with your favourite GIT client.
\end_layout
-\end_inset
+\begin_layout Subsubsection
-, section [tunnels], setup ssh command, e.g.
-
-\begin_inset Flex Code
-status collapsed
+\family sans
+Register
+\end_layout
-\begin_layout Plain Layout
-ssh=c:/path/plink.exe -i c:/path/private_key.ppk
+\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the
+\family sans
+\bar under
+R
+\bar default
+egister
+\family default
+ item is not visible.
+\end_layout
+
+\begin_layout Standard
+This command registers in GIT your document ONLY in case you have already
+ the documents directory under GIT control (in particular
+\family typewriter
+.git/index
+\family default
+ file exists).
+ This means you have to checkout the archive by yourself.
+\end_layout
+
+\begin_layout Standard
+Then you are asked interactively to supply an initial description of the
+ document.
+ Don't forget that registered file is not yet commited.
\end_layout
+\begin_layout Standard
+GIT command that is run:
+\family typewriter
+git add
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
\end_inset
-.
-\begin_inset Foot
-status collapsed
-\begin_layout Plain Layout
-It will usually take a lot of time to get exact command right and it depends
- on many things.
- For example do not have some remote server saved as a default session in
- Putty etc.
- If things fail, try to connect via plink without SVN first.
\end_layout
-\end_inset
+\begin_layout Standard
+Read
+\family typewriter
+man git
+\family default
+ to understand the switches.
+\end_layout
+\begin_layout Subsubsection
+\family sans
+Check In Changes
\end_layout
-\end_deeper
-\begin_layout Enumerate
-Checkout the SVN archive, e.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Standard
+When you are finished editing a file, you commit your changes.
+ When you do this, you are asked for a description of the changes.
+ After that changes are commited.
+\end_layout
-g.
-\begin_inset Newline newline
-\end_inset
+\begin_layout Standard
+GIT command:
+\family typewriter
+git commit -q -m"<description>" <file-name>
+\end_layout
+\begin_layout Subsubsection
-\begin_inset Flex Code
-status collapsed
+\family sans
+Revert To Repository Version
+\end_layout
-\begin_layout Plain Layout
-svn co svn+ssh://user@server/repository_path
+\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
\end_layout
+\begin_layout Standard
+GIT command:
+\family typewriter
+git checkout -q
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
\end_inset
-.
+
\end_layout
\begin_layout Subsubsection
-End-of-Line Conversions
+
+\family sans
+Rename
\end_layout
\begin_layout Standard
-When the collaborators are mixing Linux and Windows environments, LyX will
- use different line endings inside the .lyx files.
- This is not a problem as far as LyX functionality is concerned, but the
- commit diffs will be huge and merge-conflicts prone.
- Fortunately SVN itself knows
-\begin_inset Foot
-status collapsed
+This will rename the current document including the version history.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the rename operation.
+ After that the document is renamed, both locally and in the repository.
+ If the parent directories of the new and old file names differ, all relative
+ paths of included files are adjusted (like in
+\family sans
+File\SpecialChar \menuseparator
+Save As
+\family default
+\SpecialChar \ldots{}
+).
+ Finally, the document is reloaded using the new name.
+\end_layout
-\begin_layout Plain Layout
-\begin_inset Flex URL
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+GIT
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+git mv
+\family typewriter
-http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
-\end_layout
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
\end_inset
\end_inset
- how to deal with CR/LF problems when switching .lyx files to the
+
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-native
+git commit
\end_layout
\end_inset
- mode.
-\begin_inset Foot
-status collapsed
-\begin_layout Plain Layout
-For the lazy guys:
-\begin_inset Flex Code
-status collapsed
+\end_layout
-\begin_layout Plain Layout
-svn propset svn:eol-style native FILE_NAME
+\begin_layout Subsubsection
+
+\family sans
+Show History
\end_layout
+\begin_layout Standard
+This shows the complete history of the GIT document.
+ The output of
+\family typewriter
+git log
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
\end_inset
+\family default
+ is shown in a browser.
+\end_layout
+
+\begin_layout Subsubsection
+Version Info
\end_layout
-\end_inset
+\begin_layout Standard
+LyX supports GIT hash number of the last commit to the file, author name,
+ date and time of last commit.
+ All those are extracted from
+\family typewriter
+git log -n 1 --pretty=format:%H%n%an%n%ai
+\family default
+.
+ Tree version information is obtained via
+\family typewriter
+git describe --abbrev --dirty --long
+\family default
+.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:VCS-Revision-Information"
+\end_inset
+ for other details.
\end_layout
\begin_layout Subsection
in dialog, numbers always point to the last number in RCS revision number,
i.e.
'35' in '1.2.35'.
+ We don't currently support GIT addressing of revisions, one can just compare
+ edited document with its revision X steps backs, where X is addressed as
+ HEAD~X.
\end_layout
\begin_layout Section
\begin_inset space ~
\end_inset
-columns in your text, use the style
+columns in your text, insert a multicolumn inset via the menu
\family sans
-Begin Multiple Columns
-\family default
- where the columns should start.
- The content of the style is the number of the columns, so in this case
- use a
-\begin_inset Quotes eld
+Insert\SpecialChar \menuseparator
+Custom
+\begin_inset space ~
\end_inset
-2
-\begin_inset Quotes erd
+Insets\SpecialChar \menuseparator
+Multiple
+\begin_inset space ~
\end_inset
-.
- At the point where the columns should end use the style
-\family sans
-End Multiple Columns
+Columns
\family default
- and keep it empty.
+ where the columns should start.
+ Write all text that should be printed in 2
+\begin_inset space ~
+\end_inset
+
+columns into this inset.
\end_layout
\begin_layout Standard
Here is an example:
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\end_layout
-
\begin_layout Standard
\noindent
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+\noindent
\series bold
\size small
\begin_inset Newline newline
\end_inset
-by
-\noun on
-Sir Arthur Conan Doyle
+by Sir Arthur Conan Doyle
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size small
It was in the spring of the year 1894 that all London was interested, and
only withdrawn upon the third of last month.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\begin_layout Standard
+To get 3 or more columns, set the cursor into the multicolumn inset and
+ use the menu
+\family sans
+Insert\SpecialChar \menuseparator
+Number
+\begin_inset space ~
+\end_inset
+
+of
+\begin_inset space ~
+\end_inset
+
+Columns
+\family default
+.
+ The number of the desired columns is written into that inset (for 3
+\begin_inset space ~
+\end_inset
+
+columns write
+\begin_inset Quotes eld
+\end_inset
+
+3
+\begin_inset Quotes erd
+\end_inset
+
+).
+\begin_inset Newline newline
+\end_inset
+
Here is an example with 3
\begin_inset space ~
\end_inset
columns:
\end_layout
-\begin_layout Begin Multiple Columns
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size footnotesize
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
3
\end_layout
-\begin_layout Standard
+\end_inset
-\size footnotesize
It can be imagined that my close intimacy with Sherlock Holmes had interested
me deeply in crime, and that after his disappearance I never failed to
read with care the various problems which came before the public.
as they were known to the public at the conclusion of the inquest.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
You can also have columns inside columns:
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\end_layout
-
\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
\size footnotesize
The Honourable Ronald Adair was the second son of the Earl of Maynooth,
at 427 Park Lane.
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\end_layout
+\begin_layout Plain Layout
+\begin_inset Flex Multiple Columns
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\size footnotesize
The youth moved in the best society–had, so far as was known, no enemies
on the night of March 30, 1894.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size footnotesize
Ronald Adair was fond of cards–playing continually, but never for such stakes
So much for his recent history as it came out at the inquest.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\end_layout
\begin_layout Standard
-To add a preface text for multiple columns, add the optional parameter
+To add a preface text for multiple columns, set the cursor into the multicolumn
+ inset and use the menu
\family sans
+Insert\SpecialChar \menuseparator
Preface
\family default
- behind the number of columns in the
-\family sans
- Begin Multiple Columns
-\family default
- style.
- Write in there your preface.
- An example with some preface text:
+.
+ Write your preface text into that inset.
+\begin_inset Newline newline
+\end_inset
+
+This is an example with some preface text:
\end_layout
\begin_layout Standard
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\begin_inset Argument post:1
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+\begin_inset Argument 2
status open
\begin_layout Plain Layout
\end_inset
-\end_layout
-
-\begin_layout Standard
-
\size small
On the evening of the crime, he returned from the club exactly at ten.
His mother and sister were out spending the evening with a relation.
no weapon of any sort was to be found in the room.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
In this example the preface is a subsubsection:
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\begin_inset Argument post:1
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+\begin_inset Argument 2
status open
\begin_layout Plain Layout
\end_inset
-\end_layout
-
-\begin_layout Standard
-
\size small
A minute examination of the circumstances served only to make the case more
complex.
No one had heard a shot.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
a page break will be inserted before the multiple columns.
Depending on the number of lines of the preface text, you might want to
change this space.
- This is done by inserting the optional parameter
+ This is done by setting the cursor into the mulitcolumn inset behind the
+ preface (if there is any) and using the menu
\family sans
-Space before page break
+Insert\SpecialChar \menuseparator
+Space
+\begin_inset space ~
+\end_inset
+
+Before
+\begin_inset space ~
+\end_inset
+
+Page
+\begin_inset space ~
+\end_inset
+
+Break
\family default
- behind the preface.
- There insert the amount of space like e.
+.
+ Insert into that inset the amount of space like e.
\begin_inset space \thinspace{}
\end_inset
\end_inset
.
- In this example the space is set to 7
+\begin_inset Newline newline
+\end_inset
+
+In this example the space is set to 7
\begin_inset space ~
\end_inset
needs to be inserted as TeX code):
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\begin_inset Argument post:1
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
status open
\begin_layout Plain Layout
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-
-\backslash
-subsubsection{
-\end_layout
-
-\end_inset
-
-This is the sectioning command
-\begin_inset Newline newline
-\end_inset
-
-as a preface and
-\begin_inset Newline newline
-\end_inset
-
-with multiple text lines
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\end_inset
-
-
-\begin_inset Argument post:2
+\begin_inset Argument 3
status open
\begin_layout Plain Layout
\end_inset
-\end_layout
-
-\begin_layout Standard
-
\size small
On the evening of the crime, he returned from the club exactly at ten.
His mother and sister were out spending the evening with a relation.
no weapon of any sort was to be found in the room.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\end_layout
-
\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
\size small
All day I turned these facts over in my mind, endeavouring to hit upon some
me, and I knocked down several books which he was carrying.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\end_inset
-\begin_inset Note Note
-status collapsed
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+go back to the default
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+Column Breaks
+\end_layout
+
+\begin_layout Standard
+A column break can be forced by inserting the command
+\series bold
+
+\backslash
+columnbreak{}
+\series default
+ as TeX-Code to that position in the text where the column should be broken.
+ Note that this leads in most cases to whitespace in the text.
+\begin_inset Newline newline
+\end_inset
+
+Here is an example:
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You're surprised to see me, sir,
+\begin_inset Quotes erd
+\end_inset
+
+ said he, in a strange, croaking voice.
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+I acknowledged that I was.
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+Well, I've a conscience, sir, and when I chanced to see you go into this
+ house, as I came hobbling after you, I thought to myself, I'll just step
+ in and see that kind gentleman, and tell him that if I was a bit gruff
+ in my manner there was not any harm meant, and that I am much obliged to
+ him for picking up my books.
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You make too much of a trifle,
+\begin_inset Quotes erd
+\end_inset
+
+ said I.
+
+\begin_inset Quotes eld
+\end_inset
+
+May I ask how you knew who I was?
+\begin_inset Quotes erd
+\end_inset
+
+ AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+columnbreak{}
+\end_layout
+
+\end_inset
+
+
+\end_layout
\begin_layout Plain Layout
-go back to the default
-\end_layout
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
+ you'll find my little bookshop at the corner of Church Street, and very
+ happy to see you, I am sure.
+ Maybe you collect yourself, sir.
+ Here's
+\noun on
+British
+\begin_inset space ~
+\end_inset
+
+Birds
+\noun default
+, and
+\noun on
+Catullus
+\noun default
+, and
+\noun on
+The Holy War
+\noun default
+--a bargain, every one of them.
+ With five volumes you could just fill that gap on that second shelf.
+ It looks untidy, does it not, sir?
+\begin_inset Quotes erd
\end_inset
\end_layout
-\begin_layout Standard
-\begin_inset Newpage newpage
\end_inset
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\end_layout
-
\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
\size small
My observations of No.
precious volumes, a dozen of them at least, wedged under his right arm.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\end_inset
pt (this is the default), the rule is suppressed.
- In the following example the line is 2
+ In the following example the rule is 2
\begin_inset space \thinspace{}
\end_inset
\end_layout
-\begin_layout Begin Multiple Columns
-2
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You're surprised to see me, sir,
+\begin_inset Quotes erd
+\end_inset
+
+ said he, in a strange, croaking voice.
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+I acknowledged that I was.
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+Well, I've a conscience, sir, and when I chanced to see you go into this
+ house, as I came hobbling after you, I thought to myself, I'll just step
+ in and see that kind gentleman, and tell him that if I was a bit gruff
+ in my manner there was not any harm meant, and that I am much obliged to
+ him for picking up my books.
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You make too much of a trifle,
+\begin_inset Quotes erd
+\end_inset
+
+ said I.
+
+\begin_inset Quotes eld
+\end_inset
+
+May I ask how you knew who I was?
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
+ you'll find my little bookshop at the corner of Church Street, and very
+ happy to see you, I am sure.
+ Maybe you collect yourself, sir.
+ Here's
+\noun on
+British
+\begin_inset space ~
+\end_inset
+
+Birds
+\noun default
+, and
+\noun on
+Catullus
+\noun default
+, and
+\noun on
+The Holy War
+\noun default
+--a bargain, every one of them.
+ With five volumes you could just fill that gap on that second shelf.
+ It looks untidy, does it not, sir?
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace defskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+The rule can be colored by redefining the command
+\series bold
+
+\backslash
+columnseprulecolor
+\series default
+.
+ This is done by inserting the command
+\begin_inset Newline newline
+\end_inset
+
+
+\series bold
+
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+color{red}}
+\series default
+
+\begin_inset Newline newline
+\end_inset
+
+as TeX-Code before the multicolumn inset.
+ Replace
+\series bold
+red
+\series default
+ in this command by a color of your choice.
+ You can use all pre- and self-defined colors.
+ See the
+\emph on
+EmbeddedObjects
+\emph default
+ manual, section
+\emph on
+Colored
+\begin_inset space ~
+\end_inset
+
+Tables
+\emph default
+ for more information about pre- and self-defined colors.
+ To go back to the default color insert the command
+\begin_inset Newline newline
+\end_inset
+
+
+\series bold
+
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+normalcolor}
+\series default
+
+\begin_inset Newline newline
+\end_inset
+
+Here is the example with a cyan rule and 1
+\begin_inset space \thinspace{}
+\end_inset
+
+cm column separation:
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+setlength{
+\backslash
+columnsep}{1cm}
+\end_layout
+
+\begin_layout Plain Layout
+
+
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+color{cyan}}
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
\size small
\begin_inset Quotes eld
said he, in a strange, croaking voice.
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size small
I acknowledged that I was.
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size small
\begin_inset Quotes eld
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size small
\begin_inset Quotes eld
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size small
\begin_inset Quotes eld
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
columnseprule}{0pt}
\end_layout
+\begin_layout Plain Layout
+
+
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+normalcolor}
+\end_layout
+
\end_inset
\end_inset
-\end_layout
-
-\begin_layout Standard
-\begin_inset Newpage newpage
-\end_inset
-
-
\end_layout
\begin_layout Section
projects / lyx.git / blobdiff