-@input texinfo @c -*- Texinfo -*-
+\input texinfo @c -*- Texinfo -*-
@c %**start of header
@setfilename Building.linux.info
@include base/article.texi
@include building/command.texi
@paragraphindent none
-@set BG.platform linux
+@set BG-platform @value{OS-linux}
@c %**end of header
-@majorheading Guide to Building @value{HB.title} on @value{OS.@value{BG.platform}}
+@majorheading Guide to Building @value{HB-title} on @value{BG-platform}
@contents
+@sp 1
@include building/chapter.introduction.texi
@c %**-------------------------------------------------------------------------
@anchor{prerequisites}
@chapter Prerequisites
-The following are the recommended specifications for building on @value{OS.linux}; but is not necessarily the only configuration that is possible:
+The following are the recommended specifications for building on @value{OS-linux}; but is not necessarily the only configuration that is possible:
@itemize @bullet
@item Intel 32-bit or 64-bit kernel
@anchor{overview}
@chapter Overview
-@value{OS.linux} builds are performed from a @b{terminal}. There is no support for building from any IDEs.
+@value{OS-linux} builds are performed from a @b{terminal}. There is no support for building from any IDEs.
@c %**-------------------------------------------------------------------------
@include building/chapter.via.terminal.texi
-@input texinfo @c -*- Texinfo -*-
+\input texinfo @c -*- Texinfo -*-
@c %**start of header
@setfilename Building.mingw.info
@include base/article.texi
@include building/command.texi
@paragraphindent none
-@set BG.platform mingw
+@set BG-platform @value{OS-mingw}
@c %**end of header
-@majorheading Guide to Building @value{HB.title} on @value{OS.@value{BG.platform}}
+@majorheading Guide to Building @value{HB-title} on @value{BG-platform}
@contents
+@sp 1
@include building/chapter.introduction.texi
@c %**-------------------------------------------------------------------------
@anchor{prerequisites}
@chapter Prerequisites
-The following are the recommended specifications for building on @value{OS.mingw}; but is not necessarily the only configuration that is possible:
+The following are the recommended specifications for building on @value{OS-mingw}; but is not necessarily the only configuration that is possible:
@itemize @bullet
@item Intel 32-bit or 64-bit hardware
-@item @value{OS.mingw} on Fedora 17+, Ubuntu 12+ or Debian, gcc 4.6+
+@item @value{OS-mingw} on Fedora 17+, Ubuntu 12+ or Debian, gcc 4.6+
@item yasm 1.2.x (for i386 or x86_64 architectures)
@end itemize
You must set the --cross flag with configure to cross compile with windows.
See the Example below. Note that the cross compiler name varies between distributions.
-As of this writing, @value{OS.mingw} has available to it several versions of gcc; only one of which may be found and used in the path as @code{gcc} and @code{g++}. Configure will thus find what is probably the older version of gcc in a typical @value{OS.mingw} environment. If you desire to build with the newer gcc, it is found in the path as @command{gcc-4} and @command{g++-4} respectively and you must indicate to configure the desired versions. The following syntax should do the trick:
+As of this writing, @value{OS-mingw} has available to it several versions of gcc; only one of which may be found and used in the path as @code{gcc} and @code{g++}. Configure will thus find what is probably the older version of gcc in a typical @value{OS-mingw} environment. If you desire to build with the newer gcc, it is found in the path as @command{gcc-4} and @command{g++-4} respectively and you must indicate to configure the desired versions. The following syntax should do the trick:
@end quotation
@example
@anchor{overview}
@chapter Overview
-@value{OS.mingw} builds are performed from a @b{terminal}. There is no support for building from any IDEs.
+@value{OS-mingw} builds are performed from a @b{terminal}. There is no support for building from any IDEs.
@c %**-------------------------------------------------------------------------
@include building/chapter.via.terminal.texi
-@input texinfo @c -*- Texinfo -*-
+\input texinfo @c -*- Texinfo -*-
@c %**start of header
@setfilename Building.osx.info
@include base/article.texi
@include building/command.texi
@paragraphindent none
-@set BG.platform osx
+@set BG-platform @value{OS-osx}
@c %**end of header
-@majorheading Build Guide for @value{HB.name} @value{HB.version} on @value{OS.@value{BG.platform}}
-
+@majorheading Build Guide for @value{HB-name} @value{HB-version} on @value{BG-platform}
@contents
+@sp 1
@include building/chapter.introduction.texi
@c %**-------------------------------------------------------------------------
@anchor{prerequisites}
@chapter Prerequisites
-Building on @value{OS.osx} is well supported. It is the reference platform for @value{HB.name}. The following are the recommended specifications for this platform; but is not necessarily the only configuration that is possible:
+Building on @value{OS-osx} is well supported. It is the reference platform for @value{HB-name}. The following are the recommended specifications for this platform; but is not necessarily the only configuration that is possible:
@itemize @bullet
@item Mac Intel hardware
-@item @value{OS.osx} 10.7.5 or @value{OS.osx} 10.8.3
+@item @value{OS-osx} 10.7.5 or @value{OS-osx} 10.8.3
@item Xcode 4.6.1 (4H512)
@item llvm-gcc-4.2 version 4.2.1 (Based on Apple Inc. build 5658) (LLVM build 2336.11.00)
@item Xcode command-line tools (installed via Preferences > Downloads > Components)
@c %**-------------------------------------------------------------------------
@anchor{overview}
@chapter Overview
-The two general methods to build on @value{OS.osx} are from @b{terminal} or @b{Xcode.app}. The preferred method for automated and repeatable builds is to use the terminal. Otherwise the choice is generally up to the individual. To be extra clear, building from the terminal by default actually invokes @command{xcodebuild} to build the very same targets contained in the Xcode project. Think of it as building with Xcode but without the GUI.
+The two general methods to build on @value{OS-osx} are from @b{terminal} or @b{Xcode.app}. The preferred method for automated and repeatable builds is to use the terminal. Otherwise the choice is generally up to the individual. To be extra clear, building from the terminal by default actually invokes @command{xcodebuild} to build the very same targets contained in the Xcode project. Think of it as building with Xcode but without the GUI.
@c %**-------------------------------------------------------------------------
@include building/chapter.via.terminal.texi
make ub.combine
@end example
-The list of architectures is hard coded to @value{HB.name}'s desired product and currently is composed of combining the binaries produced from two xcconfigs: osx106.i386 and osx106.x86_64. The following example shows how to specify a different list of xcconfigs:
+The list of architectures is hard coded to @value{HB-name}'s desired product and currently is composed of combining the binaries produced from two xcconfigs: osx106.i386 and osx106.x86_64. The following example shows how to specify a different list of xcconfigs:
@example
./configure --disable-xcode
-@set OS.cygwin Cygwin
-@set OS.freebsd FreeBSD
-@set OS.linux Linux
-@set OS.osx Mac OS X
-@set OS.solaris Solaris
-@set OS.unix unix
-@set OS.windows Windows
-@set OS.mingw MinGW
+@set OS-cygwin Cygwin
+@set OS-freebsd FreeBSD
+@set OS-linux Linux
+@set OS-osx Mac OS X
+@set OS-solaris Solaris
+@set OS-unix unix
+@set OS-windows Windows
+@set OS-mingw MinGW
dnl
dnl
dnl
-@set HB.title __HB_title
-@set HB.name __HB_name
-@set HB.name.lower __HB_name_lower
-@set HB.name.upper __HB_name_upper
-@set HB.acro.lower __HB_acro_lower
-@set HB.acro.upper __HB_acro_upper
-@set HB.url.website __HB_url_website
-@set HB.url.community __HB_url_community
-@set HB.url.irc __HB_url_irc
-@set HB.url.appcast __HB_url_appcast
-@set HB.version.major __HB_version_major
-@set HB.version.minor __HB_version_minor
-@set HB.version.point __HB_version_point
-@set HB.version __HB_version
-@set HB.version.hex __HB_version_hex
-@set HB.build __HB_build
-@set HB.repo.url __HB_repo_url
-@set HB.repo.root __HB_repo_root
-@set HB.repo.branch __HB_repo_branch
-@set HB.repo.uuid __HB_repo_uuid
-@set HB.repo.rev __HB_repo_rev
-@set HB.repo.date __HB_repo_date
-@set HB.repo.official __HB_repo_official
-@set HB.repo.type __HB_repo_type
+@set HB-title __HB_title
+@set HB-name __HB_name
+@set HB-name-lower __HB_name_lower
+@set HB-name-upper __HB_name_upper
+@set HB-acro-lower __HB_acro_lower
+@set HB-acro-upper __HB_acro_upper
+@set HB-url-website __HB_url_website
+@set HB-url-community __HB_url_community
+@set HB-url-irc __HB_url_irc
+@set HB-url-appcast __HB_url_appcast
+@set HB-version-major __HB_version_major
+@set HB-version-minor __HB_version_minor
+@set HB-version-point __HB_version_point
+@set HB-version __HB_version
+@set HB-version-hex __HB_version_hex
+@set HB-build __HB_build
+@set HB-repo-url __HB_repo_url
+@set HB-repo-root __HB_repo_root
+@set HB-repo-branch __HB_repo_branch
+@set HB-repo-uuid __HB_repo_uuid
+@set HB-repo-rev __HB_repo_rev
+@set HB-repo-date __HB_repo_date
+@set HB-repo-official __HB_repo_official
+@set HB-repo-type __HB_repo_type
@appendix Project Repository Details
@example
-url: @value{HB.repo.url}
-root: @value{HB.repo.root}
-branch: @value{HB.repo.branch}
-uuid: @value{HB.repo.uuid}
-rev: @value{HB.repo.rev}
-date: @value{HB.repo.date}
-type: @value{HB.repo.type}
+url: @value{HB-repo-url}
+root: @value{HB-repo-root}
+branch: @value{HB-repo-branch}
+uuid: @value{HB-repo-uuid}
+rev: @value{HB-repo-rev}
+date: @value{HB-repo-date}
+type: @value{HB-repo-type}
@end example
@anchor{introduction}
@chapter Introduction
-This guide documents the recommended process to build @value{HB.name} on @value{OS.@value{BG.platform}} hosts from the official source-code repository. @b{Building from any other source is not supported}.
+This guide documents the recommended process to build @value{HB-name} on @value{BG-platform} hosts from the official source-code repository. @b{Building from any other source is not supported}.
@anchor{quickstart}
@chapter QuickStart
-This chapter is for building from a terminal/shell environment in as few commands as possible. Upon completion of the following commands you should have a fresh build of @value{HB.name}. Further instructions are available beginning with @ref{overview} which describes procedures suitable for repeating builds. This chapter should be skipped by those seeking more than a minimalist build.
+This chapter is for building from a terminal/shell environment in as few commands as possible. Upon completion of the following commands you should have a fresh build of @value{HB-name}. Further instructions are available beginning with @ref{overview} which describes procedures suitable for repeating builds. This chapter should be skipped by those seeking more than a minimalist build.
@example
-@COMMAND.checkout{}
+@COMMAND-checkout{}
./configure --launch
@end example
Record of output from @command{configure --launch}. Similar output may be recorded using @command{make} depending on which shell is in use, eg: @command{make >& log/build.txt} or @command{make > log/build.txt 2>&1}.
@item log/xcodemake.env.txt
-Environment (variables) dump as seen when Xcode forks @command{make}. @value{OS.osx} only.
+Environment (variables) dump as seen when Xcode forks @command{make}. @value{OS-osx} only.
@end table
List available options.
@item --src=DIR
-Specify top-level source directory for @value{HB.name} sources.
+Specify top-level source directory for @value{HB-name} sources.
@item --build=DIR
Specify destination directory for final product install. The default is to use either @file{build} if in the top-level source directory, otherwise @file{.}
Useful for novices and quick-start procedures.
@item --disable-gtk
-Disable building the GTK GUI on applicable platforms such as @value{OS.linux}.
+Disable building the GTK GUI on applicable platforms such as @value{OS-linux}.
@item --debug=MODE
Select debug mode. Must be one of @samp{none}, @samp{min}, @samp{std}, @samp{max}.
This generally maps to gcc options @samp{-g0}, @samp{-O0}, @samp{-O3}, @samp{-Os}.
@item --arch=MODE
-Select build architecture. The available architectures vary by platform. Most platforms support exactly one architecture except @value{OS.osx} which has support for various universal binary architectures. The available choices are hard-coded per platform and no sanity checks for the required tools are performed.
+Select build architecture. The available architectures vary by platform. Most platforms support exactly one architecture except @value{OS-osx} which has support for various universal binary architectures. The available choices are hard-coded per platform and no sanity checks for the required tools are performed.
@item --disable-xcode
-Disable shunting the build through @command{xcodebuild}. If this option is applied, @command{HandBrakeCLI} will be produced in a similar fashion as it is on other platforms; sans Xcode and the Cocoa application will not be produced. @value{OS.osx} only.
+Disable shunting the build through @command{xcodebuild}. If this option is applied, @command{HandBrakeCLI} will be produced in a similar fashion as it is on other platforms; sans Xcode and the Cocoa application will not be produced. @value{OS-osx} only.
@item --xcconfig=MODE
-Select Xcode project configuration file. The available modes are the basenames of files located in @file{macosx/xcconfig/*.xcconfig} which direct Xcode to build using various architecture and @value{OS.osx} deployment options. @value{OS.osx} only.
+Select Xcode project configuration file. The available modes are the basenames of files located in @file{macosx/xcconfig/*.xcconfig} which direct Xcode to build using various architecture and @value{OS-osx} deployment options. @value{OS-osx} only.
@end table
Clean-room procedures dictate that when certain factors change, old builds should be scrapped and new builds configured. This is the main reason for requiring a scratch directory; to promote consistent, reliable and clean software builds. The following is a short list of some of the reasons why someone may choose to scrap an existing build:
Perform the following steps to build:
@itemize
-@item Finder - navigate to @file{macosx/} in the @value{HB.name} source tree
+@item Finder - navigate to @file{macosx/} in the @value{HB-name} source tree
@item Finder - open @file{HandBrake.xcodeproj}
@item Xcode workspace - select scheme @b{HandBrake [RELEASE]}
@item Xcode menu - select Product -> Build
@itemize
@item Xcode menu - select Window -> Organizer
@item Xcode organizer - select Projects tab
-@item Xcode organizer Projects - select @value{HB.name} item
-@item @value{HB.name} item - click Derived Data location arrow (immediately right of path)
+@item Xcode organizer Projects - select @value{HB-name} item
+@item @value{HB-name} item - click Derived Data location arrow (immediately right of path)
@item Finder - navigate to Build -> Products -> release
@end itemize
@itemize
@item Xcode menu - select Window -> Organizer
@item Xcode organizer - select Projects tab
-@item Xcode organizer Projects - select @value{HB.name} item
-@item @value{HB.name} item - click Derived Data location arrow (immediately right of path)
+@item Xcode organizer Projects - select @value{HB-name} item
+@item @value{HB-name} item - click Derived Data location arrow (immediately right of path)
@item Finder - navigate to Build -> Products -> release -> external
@end itemize
Modify for faster external builds if your system has the horsepower and resources. Specifying a value greater than the number of CPU cores (or virtual cores) in your system is unlikely to produce gains and will needlessly consume extra resources. A special string value of @b{auto} sets the factor to the number of active CPUs on the host system.
@item EXTERNAL_SRC
-Do not modify; specifies the top-level source directory for @value{HB.name}, relative to Xcode project.
+Do not modify; specifies the top-level source directory for @value{HB-name}, relative to Xcode project.
@item EXTERNAL_XCCONFIG
Do not modify; specifies which xcconfig file is active. Defined inside xcconfig file.
-@macro COMMAND.checkout{}
-svn checkout @value{HB.repo.url} @value{HB.acro.lower}-@value{HB.repo.branch}
-cd @value{HB.acro.lower}-@value{HB.repo.branch}
+@macro COMMAND-checkout{}
+svn checkout @value{HB-repo-url} @value{HB-acro-lower}-@value{HB-repo-branch}
+cd @value{HB-acro-lower}-@value{HB-repo-branch}
@end macro
-Checkout @value{HB.name} from the official source-code repository.
+Checkout @value{HB-name} from the official source-code repository.
@example
-@COMMAND.checkout{}
+@COMMAND-checkout{}
@end example
-Sources are checked out from the @samp{@value{HB.repo.branch}} branch. This document was generated from that very branch, and for example purposes, we will use exactly the same branch.
+Sources are checked out from the @samp{@value{HB-repo-branch}} branch. This document was generated from that very branch, and for example purposes, we will use exactly the same branch.
If you have write-access to the repository, then you may add the appropriate login/password information as needed. It is recommended to use Subversion 1.6.0 or higher. Lower versions should also work.
projects / handbrake / commitdiff