From: Спицын Андрей Date: Fri, 1 Mar 2019 21:30:13 +0000 (+0300) Subject: Add tex files and images X-Git-Tag: 2021-05~272 X-Git-Url: https://git.cinelerra-gg.org/git/?p=goodguy%2Fcin-manual-latex.git;a=commitdiff_plain;h=43c38165af4bf46c38c4f56e35c21dfceb4257e6;ds=sidebyside Add tex files and images --- diff --git a/.gitignore b/.gitignore index 894a44c..17ca208 100644 --- a/.gitignore +++ b/.gitignore @@ -1,104 +1,41 @@ -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - -# Distribution / packaging -.Python -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -.hypothesis/ -.pytest_cache/ - -# Translations -*.mo -*.pot - -# Django stuff: +# In .gitignore +*.aux +*.glo +*.idx *.log -local_settings.py -db.sqlite3 - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# pyenv -.python-version - -# celery beat schedule file -celerybeat-schedule - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject +*.toc +*.ist +*.acn +*.acr +*.alg +*.bbl +*.blg +*.dvi +*.glg +*.gls +*.ilg +*.ind +*.lof +*.lot +*.maf +*.mtc +*.mtc1 +*.out +*.synctex.gz +*.synctex(busy) +*.bak +*.pdf +*.swp +*.fdb_latexmk +*.fls +*.nav +*.pdfpc +*.nlo +*.nls +*.dep +*.snp +*.bcf +*.run.xml +*.dvv -# mkdocs documentation -/site -# mypy -.mypy_cache/ diff --git a/common/packages.tex b/common/packages.tex new file mode 100644 index 0000000..c7fdde2 --- /dev/null +++ b/common/packages.tex @@ -0,0 +1,133 @@ + +\usepackage{cmap} +\usepackage[T2A]{fontenc} +\usepackage[utf8]{inputenc} % file encoding +\usepackage[english]{babel} % default language for document +\usepackage{ + amssymb, + amsfonts, + mathtools, + mathtext, + cite, + enumerate, + float, + textcomp +} % some packages +%\usepackage[font={small}]{caption} +\usepackage{hhline} % beautiful links +\usepackage{hyperref} % beautiful links +\usepackage{pdflscape} % landscape pages +\usepackage{longtable} % longtable support +\usepackage{multirow} % vertical cell in table +\usepackage{bigstrut} % big strut +\usepackage{array} % additional cell aligh +\usepackage{indentfirst} % first line indent +\usepackage{gensymb} % symbols + +%\usepackage[nottoc]{tocbibind} % do we need bibliography in toc +%---------------------------------------------- +%\usepackage{mhchem} +%=============== Font for tables ============ +\let\oldtabular\tabular +\renewcommand{\tabular}{\small\oldtabular} +\hypersetup{colorlinks=true, + linkcolor=blue, + citecolor=blue, + filecolor=blue, + urlcolor=blue, + pdftitle={Cinelerra GG Infinity Manual}, + pdfauthor={Cinelerra Authors}, + pdfsubject={Video Editing}, + pdfkeywords={Cinelerra, Good Guy} +} % pdf properties +\usepackage[pdftex]{graphicx} % do we need some figures in our pdf +\graphicspath{{images/}} % path to images +%% drawing package +\usepackage{tikz} +%---------------------------------------------------------------------- +\usepackage{listings} % include code +\lstset{ % begin settings + %language=R, % the language of the code + inputencoding=utf8, + basicstyle=\footnotesize, % the size of the fonts that are used for the code + numbers=left, % where to put the line-numbers + numberstyle=\tiny\color{black}, % the style that is used for the line-numbers + stepnumber=1, % the step between two line-numbers. If it's 1, each line + % will be numbered + numbersep=5pt, % how far the line-numbers are from the code + %backgroundcolor=\color{white}, % choose the background color. You must add \usepackage{color} + showspaces=false, % show spaces adding particular underscores + showstringspaces=false, % underline spaces within strings + showtabs=false, % show tabs within strings adding particular underscores + frame=lines, % adds a frame around the code + %frame=single, % adds a frame around the code + rulecolor=\color{black}, % if not set, the frame-color may be changed on line-breaks within not-black text (e.g. commens (green here)) + tabsize=2, % sets default tabsize to 2 spaces + captionpos=b, % sets the caption-position to bottom + breaklines=true, % sets automatic line breaking + breakatwhitespace=false, % sets if automatic breaks should only happen at whitespace + title=\lstname, % show the filename of files included with \lstinputlisting; + % also try caption instead of title + keywordstyle=\color{blue}, % keyword style + commentstyle=\color{gray}, % comment style + stringstyle=\color{black}, % string literal style + %backgroundcolor=\color{green!10}, + escapeinside={\%*}{*)}, % if you want to add a comment within your code + extendedchars=\true, + %keepspaces = true %!!!! spaces in comments + texcl=true, + morekeywords={*,...} % if you want to add more keywords to the set +} +%======================геометрия полей +\usepackage{geometry} % Меняем поля страницы +\geometry{left=2.0cm}% левое поле +\geometry{right=2.0cm}% правое поле +\geometry{top=2.0cm}% верхнее поле +\geometry{bottom=1.0cm}% нижнее поле +\parindent=1.0cm %красная срока +\righthyphenmin=2 %разрешить перенос 2-х последних букв +%--------------------------------------------------------------------------- +\makeatletter +\renewcommand{\@biblabel}[1]{#1.} +%--------------------------------------------------------------- + +% Title page definition +%\providecommand{\HUGE}{\Huge}% if not using memoir +\newlength{\drop}% for my convenience +%% specify the Webomints family +%\newcommand*{\wb}[1]{\fontsize{#1}{#2}\usefont{U}{webo}{xl}{n}} +%% select a (FontSite) font by its font family ID +\newcommand*{\FSfont}[1]{\fontencoding{T1}\fontfamily{#1}\selectfont} +%% if you don’t have the FontSite fonts either \renewcommand*{\FSfont}[1]{} +%% or use your own choice of family. +%% select a (TeX Font) font by its font family ID +\newcommand*{\TXfont}[1]{\fontencoding{T1}\fontfamily{#1}\selectfont} +%% Generic publisher’s logo +\newcommand*{\plogo}{\fbox{$\mathcal{PL}$}} +%% Some shades +\definecolor{Dark}{gray}{0.2} +\definecolor{MedDark}{gray}{0.4} +\definecolor{Medium}{gray}{0.6} +\definecolor{Light}{gray}{0.8} +%%%% Additional font series macros + +\newcommand*{\titleLL}{\begingroup% Lost Languages +\drop=0.1\textheight +\fboxsep 0.5\baselineskip +\sffamily +\vspace*{\drop} +\centering +{\textcolor{Dark}{\HUGE Cinelerra-GG Version Infinity}}\par +\vspace{0.5\drop} +{\includegraphics[width=0.1\linewidth]{./images/cin-logo}}\par +\vspace{0.5\drop} +\colorbox{Dark}{\textcolor{white}{\normalfont\itshape\Large +User Manual}}\par +\vspace{0.3\drop} +{\Large Last update}\\ +{\footnotesize \today}\\ +\url{https://www.cinelerra-gg.org}\par +\vspace*{\drop} +{\includegraphics[width=0.5\linewidth]{./images/cin-big.png}}\par +\endgroup} + diff --git a/feature5.tex b/feature5.tex new file mode 100644 index 0000000..a3c28db --- /dev/null +++ b/feature5.tex @@ -0,0 +1,41 @@ +% +\documentclass[letter,14pt,oneside,openright,svgnames]{memoir} % paper size, font size and other options for document +%\input{common/setup.tex} +\input{common/packages.tex} % common packages + + +%\includeonly{parts/Disclaimer} +\begin{document} + +\titleLL % use cutom title + +\thispagestyle{empty} % no page numbers + +\newpage + +\mainmatter +\tableofcontents +\pagestyle{plain} +%\renewcommand{\chapterheadstart}{ +%%\vspace*{\beforechapskip} +%\hrule\medskip} +%\renewcommand{\chapnamefont}{\normalfont\large\scshape} +%\renewcommand{\chapnumfont}{\normalfont\large\scshape} +%\renewcommand{\chaptitlefont}{\normalfont\large\scshape} +%\renewcommand{\printchaptername}{\normalfont\large\scshape История} +%\renewcommand{\chapternamenum}{ } +%\renewcommand{\printchapternum}{\chapnumfont \thechapter} +%\renewcommand{\afterchapternum}{. } +%\renewcommand{\afterchapskip}{\vspace{2ex}} +%\renewcommand{\afterchaptertitle}{\par\nobreak\medskip\hrule\vskip +%\afterchapskip} +%} +\chapterstyle{madsen} % one of chapter header style for memoir documentclass +%\renewcommand{\printchaptername}{\normalfont\large\scshape Chapter} +\renewcommand{\chapterheadstart}{} +%\renewcommand{\beforechapskip}{\vspace{2pt}} + +\include{parts/Introduction} +\include{parts/Instalation} + +\end{document} diff --git a/images/cin-big.png b/images/cin-big.png new file mode 100644 index 0000000..45252b6 Binary files /dev/null and b/images/cin-big.png differ diff --git a/images/cin-logo.png b/images/cin-logo.png new file mode 100644 index 0000000..f1f4ea0 Binary files /dev/null and b/images/cin-logo.png differ diff --git a/parts/Instalation.tex b/parts/Instalation.tex new file mode 100644 index 0000000..b0e79ff --- /dev/null +++ b/parts/Instalation.tex @@ -0,0 +1,127 @@ +\chapter{Installation} +\label{cha:Instalation} + +This manual covers features or areas of Cinelerra that are different or new in the Cinelerra-GG Infinity +version. Many of the new features were created by a lot of different people to include the original +author and were merged in from various sources and each person is to be commended for their efforts. +The content of this manual also came from various people/places/email and thanks to all. + +The standard Cinelerra Manual covers “The Secrets of Cinelerra” and can be found at:\par +\url{ +https://cinelerra-cv.org/docs/cinelerra_cv_manual_en.html +} +\section{How to Build Cinelerra-GG Infinity from Developer's Git Repository}% +\label{sec:} + +These are generic build instructions for building Cinelerra-GG Infinity. Known to work on ubuntu, +mint, suse, fedora, debian, centos, arch, and 32-bit slackware. It has not been tested on every single +possible distro yet so you might expect to have to make some minor changes. It has failed miserably +on FreeBSD. At least once, a Gentoo version was successfully created. + +Alternatively, there are some pre-built dynamic or static binaries which are updated on a fairly regular +basis (as long as code changes have been made) available at link below. See Section 1.2. + +\url{https://cinelerra-gg.org/download/} + There are 2 kinds of builds, the default system-build and a single-user build. A system build has results +which are installed to the system. The majority of the files are installed in the standard system paths, +but some customization is possible. The single user build allows for running completely out of a local +user directory so it doesn't affect the system. + +We recommend the single-user version when possible. It makes it very easy to install a new version +without having to delete the older version in case you want it for backup – once you are happy with the +new version, all you have to do is delete the entire old directory path. Also, if you install a new +Operating System version and if you have Cinelerra on separate disk space that is preserved, you won't +have to reinstall Cinelerra. In addition for purposes of having the ability to interrupt or to see any +possible error messages, if you start the application from a terminal window command line you will +have more control to catch problems. The system builds can be useful in a university lab setting where +there are possibly multiple users, or multiple versions. + +There are two notable differences between “standard” views of Cinelerra and this implementation for +the system builds. Both of these can be configured during installation. These differences make it +possible to have several different versions installed without having them “walk” on each other.ault system-build an + +\begin{enumerate} + \item + application name can be set during installation and defaults to: “\texttt{cin}” + \item + the home configuration directory can also be set and defaults to:\\ “\texttt{\$HOME/.bcast5}” + + +\end{enumerate} +\paragraph{To do a system build,} you should read the \texttt{README} that is at the top level after you get the source. + +\begin{enumerate} + \item + You need at least 2.5GB of disk storage to operate a build. Need to have “\texttt{git}” installed. + \item Obviously in order to install into the system, you must run as root. + \item The "\texttt{git}" step has to download a bunch of stuff (approx 100MB) so allow time. + \item Run the following commands (this takes awhile): + \begin{lstlisting}[language=bash] +cd // +# this is where you need the 2.5GB of disk space +git clone --depth 1 "git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5 +cd cinelerra5/cinelerra-5.1 # toplevel directory + \end{lstlisting} + NOTE: if your system has never had Cinelerra-GG Infinity installed, you will have to make sure you + have all of the compilers and libraries necessary. So on the very first build you should run: + + \begin{lstlisting}[language=bash] +./blds/bld_prepare.sh # where represents the Operating System of centos, fedora, suse, leap, ubuntu, debian. +./autogen.sh +./configure --prefix=/usr +# optional parameters can be added here +make 2>&1 | tee log +# make and log the build +\end{lstlisting} +\item Check for obvious build errors: + \begin{lstlisting}[language=bash] +grep "\*\*\*.*error" -ai log + \end{lstlisting} + If this reports errors and you need assistance or you think improvements can be made to the build s, + email the log which is listed below to cin@lists.cinelerra-gg.org: + \begin{lstlisting}[language=bash] +//cinelerra5/cinelerra-5.1/log + \end{lstlisting} +\item If there are no build errors, finally just run: + \begin{lstlisting}[language=bash] + make install + \end{lstlisting} +\item If it all worked, you are all setup. Just click on the “blue lady” cinelerra desktop icon. +\end{enumerate} + +\paragraph{To do a single-user build,} read the \texttt{README} that is at the top level after you get the source. +\begin{enumerate} + \item You need at least 2.5GB of disk storage to operate a build. Need to have “\texttt{git}” installed. + \item Recommend you build and run as root, just to avoid permission issues initially. + \item The "\texttt{git}" step has to download a bunch of stuff (approx 100MB) so allow time. + \item Run the following commands (this takes awhile): + \begin{lstlisting}[language=bash] +cd // +# this is where you need the 2.5GB of disk space +git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5 +cd cinelerra5/cinelerra-5.1 + \end{lstlisting} +\end{enumerate} +NOTE: if your system has never had Cinelerra-GG Infinity installed, you will have to make sure all +the compilers and libraries necessary are installed. So on the very first build you should run as root: +\begin{lstlisting}[language=bash] +./blds/bld_prepare.sh # where represents the Operating System of +centos, fedora, suse, leap, ubuntu, debian. +./autogen.sh +./configure --with-single-user +# the “with-single-user” parameter makes it so +make 2>&1 | tee log +# make and log build (check for errors before proceeding) +make install +\end{lstlisting} + +Then just start the application by keying in: ./cin in the bin subdirectory OR add a desktop icon by +using the appropriate directory to copy the files to, run as root, and edit to correct the directory path. +\begin{lstlisting}[language=bash] +cd /cinelerra_directory_path +cp -a image/cin.{svg,xpm} /usr/share/pixmaps/. +cp -a image/cin.desktop /usr/share/applications/cin.desktop +change the “Exec=cin” line to be “Exec=/bin/cin” +\end{lstlisting} +The preceding directions for doing a single-user build has been meticulously followed to build and run +on a newly installed ubuntu 15 system WITHOUT BEING ROOT except for the \texttt{bld\_prepare.sh} and creating the desktop icon. diff --git a/parts/Introduction.tex b/parts/Introduction.tex new file mode 100644 index 0000000..cecc588 --- /dev/null +++ b/parts/Introduction.tex @@ -0,0 +1,62 @@ +\chapter{Introduction}% +\label{cha:introduction} + +Cinelerra is a software program NLE, Non-Linear Editor, that provides a way to edit, record, and play audio or video media. +It can also be used to retouch photos. + +This manual covers Cinelerra-GG Infinity version. +The author of the original Cinelerra, Adam Williams, as well as many different people worked on Cinelerra over the years. +The software and this manual were merged in from various sources and each person is to be thanked and commended for their efforts. +Numerous software modifications were made by William Morrow. +These are all under GPLv2+ license. +Refer to: \url{https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html} + + +\textbf{This is a copy of the header from the original source code.} +\begin{lstlisting}[language=bash,numbers=none] +/* +* CINELERRA +* Copyright (C) 1997-2012 Adam Williams +* +* This program is free software; you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published by +* the Free Software Foundation; either version 2 of the License, or +* (at your option) any later version. +* +* This program is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with this program; if not, write to the Free Software +* Foundation, Inc., 59 Temple Place, Suite 330, Boston +\end{lstlisting} +\textbf{This is a copy of the information in the Cinelerra-CV manual.} + +Copyright c 2003, 2004, 2005, 2006 Adam Williams - Heroine Virtual Ltd. +Copyright c 2003, 2004, 2005, 2006, 2007 Cinelerra CV Team. + +This manual is free; you can redistribute it and/or modify it under the terms of the GNU General +Public License as published by the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This document is distributed in the hope that it will be useful, but WITHOUT ANY WAR- +RANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with this program; +if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, U + +\section{Cinelerra Overview}% +\label{sec:cinelerra_overview} + +Presented briefly here is an overview of Cinelerra-GG Infinity and information provided in this manual. +The GG version of Cinelerra has been improved for \emph{stability}, \emph{modernized} to accommodate the +\emph{current state} of Linux software, enhanced with additional \emph{basic features}, and enriched with \emph{new features} imagined by dedicated users and then implemented by professional programmers. + + + + + +