[Ttssh2-commit] [7565] cmakeを使ったビルドについてのドキュメントをdoc/にまとめた

scmno****@osdn***** scmno****@osdn*****
2019年 4月 10日 (水) 01:23:39 JST


Revision: 7565
          https://osdn.net/projects/ttssh2/scm/svn/commits/7565
Author:   zmatsuo
Date:     2019-04-10 01:23:39 +0900 (Wed, 10 Apr 2019)
Log Message:
-----------
cmakeを使ったビルドについてのドキュメントをdoc/にまとめた

Modified Paths:
--------------
    trunk/doc/convtext.bat
    trunk/doc/en/html/index.html
    trunk/doc/en/teraterm.hhc
    trunk/doc/ja/html/index.html
    trunk/doc/ja/html/reference/build_with_cmake.md
    trunk/doc/ja/teraterm.hhc
    trunk/libs/build_library_with_cmake.md

Added Paths:
-----------
    trunk/doc/en/html/reference/build_library_with_cmake.md
    trunk/doc/ja/html/reference/build_library_with_cmake.md

-------------- next part --------------
Modified: trunk/doc/convtext.bat
===================================================================
--- trunk/doc/convtext.bat	2019-04-09 16:23:23 UTC (rev 7564)
+++ trunk/doc/convtext.bat	2019-04-09 16:23:39 UTC (rev 7565)
@@ -21,3 +21,8 @@
 %TOSJIS% -i ja/html/reference/build_with_cmake_utf8.html -o ja/html/reference/build_with_cmake.html  -c utf8
 perl -C -pe 'tr/\x{feff}//d' en/html/reference/build_with_cmake.md | perl Markdown_1.0.1/Markdown.pl > en/html/reference/build_with_cmake_utf8.html
 %TOSJIS% -i en/html/reference/build_with_cmake_utf8.html -o en/html/reference/build_with_cmake.html  -c utf8
+
+perl -C -pe 'tr/\x{feff}//d' ja/html/reference/build_library_with_cmake.md | perl Markdown_1.0.1/Markdown.pl > ja/html/reference/build_library_with_cmake_utf8.html
+%TOSJIS% -i ja/html/reference/build_library_with_cmake_utf8.html -o ja/html/reference/build_library_with_cmake.html  -c utf8
+perl -C -pe 'tr/\x{feff}//d' en/html/reference/build_library_with_cmake.md | perl Markdown_1.0.1/Markdown.pl > en/html/reference/build_library_with_cmake_utf8.html
+%TOSJIS% -i en/html/reference/build_library_with_cmake_utf8.html -o en/html/reference/build_library_with_cmake.html  -c utf8

Modified: trunk/doc/en/html/index.html
===================================================================
--- trunk/doc/en/html/index.html	2019-04-09 16:23:23 UTC (rev 7564)
+++ trunk/doc/en/html/index.html	2019-04-09 16:23:39 UTC (rev 7565)
@@ -145,7 +145,11 @@
  <LI><A HREF="reference/CygTerm+-LICENSE.txt">License of CygTerm+</A></LI>
  <LI><A HREF="reference/develop.txt">For developer</A>
  <UL>
-   <LI><A HREF="reference/build_with_cmake.html">build with CMake (experimental)</A></LI>
+   <LI>build with CMake (experimental)</LI>
+   <UL>
+	 <LI><A HREF="reference/build_library_with_cmake.html">library</A></LI>
+	 <LI><A HREF="reference/build_with_cmake.html">Tera Term</A></LI>
+   </UL>
  </UL>
  <LI><A HREF="reference/sourcecode.html">Source Code Overview</A></LI>
 </UL>

Added: trunk/doc/en/html/reference/build_library_with_cmake.md
===================================================================
--- trunk/doc/en/html/reference/build_library_with_cmake.md	                        (rev 0)
+++ trunk/doc/en/html/reference/build_library_with_cmake.md	2019-04-09 16:23:39 UTC (rev 7565)
@@ -0,0 +1,98 @@
+
+# libsフォルダ
+
+- Tera Term のビルドに利用する外部のライブラリを置いておくためのフォルダ
+- 各コンパイラ向けにソース/ライブラリ/実行ファイルを置いておく
+- ライブラリはあらかじめ1度だけ生成しておく
+
+# 準備
+
+## Visual Studio
+
+- cmake
+	- PATHが通してあればok
+	- cygwinのcmakeはつかえない(Visual Studioをサポートしていない)
+	- Visual Studio 2005 を使う場合は cmake 3.11.4 を使用する必要がある
+- perl
+	- OpenSSL のコンパイル、ドキュメントファイルの文字コード・改行コード変換に必要
+	- ActivePerl 5.8 以上、または cygwin perl
+	- PATHが通っていなければ自動で探す
+
+## MinGW 共通 (experimental)
+
+- Cygwin,MSYS2,linux(wsl)上のMinGWでビルド可能
+- 各環境で動作するcmake,make,(MinGW)gcc,(clang),perlが必要
+
+# ビルド手順
+
+必要なアーカイブを自動的にダウンロードするので、
+インターネットが利用できる環境でビルドする必要がある
+
+## Visual Studioの場合
+
+### batファイルを使用する場合
+
+buildall_cmake.bat を実行して使用する Visual Studioを選ぶ
+
+    1. Visual Studio 16 2019
+    2. Visual Studio 15 2017
+    3. Visual Studio 14 2015
+    4. Visual Studio 12 2013
+    5. Visual Studio 11 2012
+    6. Visual Studio 10 2010
+    7. Visual Studio 9 2008
+    8. Visual Studio 8 2005
+    select no
+
+VS2005を選択した場合、
+このバッチファイルから cmake 3.11.4 をダウンロードして `libs\cmake-3.11.4-win32-x86` に
+インストールできます。
+
+### cmakeを使用する場合
+
+Visual Studio 2019 x86 の場合
+
+    cmake -DCMAKE_GENERATOR="Visual Studio 16 2019" -DARCHITECTURE=Win32 -P buildall.cmake
+
+Visual Studio 2017 x86 の場合
+
+    cmake -DCMAKE_GENERATOR="Visual Studio 15 2017" -P buildall.cmake
+
+Visual Studio 2017 x64 の場合
+
+    cmake -DCMAKE_GENERATOR="Visual Studio 15 2017 Win64" -P buildall.cmake`
+
+Visual Studio 2005の場合は、cmakeのバージョン3.11.4以前を使用
+(cmake が libs\cmake-3.11.4-win32-x86 にインストールしてある場合)
+
+    libs\cmake-3.11.4-win32-x86\bin\cmake.exe" -DCMAKE_GENERATOR="Visual Studio 8 2005" -P buildall.cmake
+
+## MinGW 共通
+
+各々の環境のcmakeを使用する
+
+    cmake -DCMAKE_GENERATOR="Unix Makefiles" -P buildall.cmake
+
+# 各フォルダについて
+
+## 生成されるライブラリフォルダ
+
+- 次のフォルダにライブラリの `*.h` , `*.lib` が生成される
+	- `oniguruma_{compiler}`
+	- `openssl_{compiler}`
+	- `putty`
+	- `SFMT_{compiler}`
+	- `zlib_{compiler}`
+
+## download アーカイブダウンロードフォルダ
+
+- ダウンロードしたアーカイブファイルが置かれる
+- 自動でダウンロードされる
+- ダウンロードされていると再利用する
+- ビルド後、参照する必要がなければ削除できる
+
+## build ビルドフォルダ
+
+- `build/oniguruma/{compiler}/` などの下でビルドされる
+- 再ビルドするときは、あらかじめ削除すること
+- ビルド後、参照する必要がなければ削除できる

Modified: trunk/doc/en/teraterm.hhc
===================================================================
--- trunk/doc/en/teraterm.hhc	2019-04-09 16:23:23 UTC (rev 7564)
+++ trunk/doc/en/teraterm.hhc	2019-04-09 16:23:39 UTC (rev 7565)
@@ -583,9 +583,20 @@
 		<UL>
 			<LI> <OBJECT type="text/sitemap">
 				<param name="Name" value="Build with CMake build system (experimental)">
-				<param name="Local" value="html\reference\build_with_cmake.html">
 				<param name="ImageNumber" value="11">
 				</OBJECT>
+			<UL>
+				<LI> <OBJECT type="text/sitemap">
+					<param name="Name" value="library">
+					<param name="Local" value="html\reference\build_library_with_cmake.html">
+					<param name="ImageNumber" value="11">
+				  </OBJECT>
+				<LI> <OBJECT type="text/sitemap">
+					<param name="Name" value="Tera Term">
+					<param name="Local" value="html\reference\build_with_cmake.html">
+					<param name="ImageNumber" value="11">
+				  </OBJECT>
+			</UL>
 		</UL>
 		<LI> <OBJECT type="text/sitemap">
 			<param name="Name" value="Source Code Overview">

Modified: trunk/doc/ja/html/index.html
===================================================================
--- trunk/doc/ja/html/index.html	2019-04-09 16:23:23 UTC (rev 7564)
+++ trunk/doc/ja/html/index.html	2019-04-09 16:23:39 UTC (rev 7565)
@@ -145,7 +145,11 @@
  <LI><A HREF="reference/CygTerm+-LICENSE.txt">CygTerm+ \x83\x89\x83C\x83Z\x83\x93\x83X</A></LI>
  <LI><A HREF="reference/develop.txt">\x8AJ\x94\xAD\x8EҌ\xFC\x82\xAF</A></LI>
  <UL>
-   <LI><A HREF="reference/build_with_cmake.html">CMake\x83r\x83\x8B\x83h\x83V\x83X\x83e\x83\x80\x82\xF0\x8Eg\x97p\x82\xB5\x82\xBD\x83r\x83\x8B\x83h(experimental)</A></LI>
+   <LI>CMake\x83r\x83\x8B\x83h\x83V\x83X\x83e\x83\x80\x82\xF0\x8Eg\x97p\x82\xB5\x82\xBD\x83r\x83\x8B\x83h(experimental)</LI>
+   <UL>
+	 <LI><A HREF="reference/build_library_with_cmake.html">\x83\x89\x83C\x83u\x83\x89\x83\x8A\x82̃r\x83\x8B\x83h</A></LI>
+	 <LI><A HREF="reference/build_with_cmake.html">Tera Term\x82̃r\x83\x8B\x83h</A></LI>
+   </UL>
  </UL>
  <LI><A HREF="reference/sourcecode.html">\x83\\x81[\x83X\x83R\x81[\x83h\x89\xF0\x90\xE0</A></LI>
 </UL>

Added: trunk/doc/ja/html/reference/build_library_with_cmake.md
===================================================================
--- trunk/doc/ja/html/reference/build_library_with_cmake.md	                        (rev 0)
+++ trunk/doc/ja/html/reference/build_library_with_cmake.md	2019-04-09 16:23:39 UTC (rev 7565)
@@ -0,0 +1,98 @@
+
+# libsフォルダ
+
+- Tera Term のビルドに利用する外部のライブラリを置いておくためのフォルダ
+- 各コンパイラ向けにソース/ライブラリ/実行ファイルを置いておく
+- ライブラリはあらかじめ1度だけ生成しておく
+
+# 準備
+
+## Visual Studio
+
+- cmake
+	- PATHが通してあればok
+	- cygwinのcmakeはつかえない(Visual Studioをサポートしていない)
+	- Visual Studio 2005 を使う場合は cmake 3.11.4 を使用する必要がある
+- perl
+	- OpenSSL のコンパイル、ドキュメントファイルの文字コード・改行コード変換に必要
+	- ActivePerl 5.8 以上、または cygwin perl
+	- PATHが通っていなければ自動で探す
+
+## MinGW 共通 (experimental)
+
+- Cygwin,MSYS2,linux(wsl)上のMinGWでビルド可能
+- 各環境で動作するcmake,make,(MinGW)gcc,(clang),perlが必要
+
+# ビルド手順
+
+必要なアーカイブを自動的にダウンロードするので、
+インターネットが利用できる環境でビルドする必要がある
+
+## Visual Studioの場合
+
+### batファイルを使用する場合
+
+buildall_cmake.bat を実行して使用する Visual Studioを選ぶ
+
+    1. Visual Studio 16 2019
+    2. Visual Studio 15 2017
+    3. Visual Studio 14 2015
+    4. Visual Studio 12 2013
+    5. Visual Studio 11 2012
+    6. Visual Studio 10 2010
+    7. Visual Studio 9 2008
+    8. Visual Studio 8 2005
+    select no
+
+VS2005を選択した場合、
+このバッチファイルから cmake 3.11.4 をダウンロードして `libs\cmake-3.11.4-win32-x86` に
+インストールできます。
+
+### cmakeを使用する場合
+
+Visual Studio 2019 x86 の場合
+
+    cmake -DCMAKE_GENERATOR="Visual Studio 16 2019" -DARCHITECTURE=Win32 -P buildall.cmake
+
+Visual Studio 2017 x86 の場合
+
+    cmake -DCMAKE_GENERATOR="Visual Studio 15 2017" -P buildall.cmake
+
+Visual Studio 2017 x64 の場合
+
+    cmake -DCMAKE_GENERATOR="Visual Studio 15 2017 Win64" -P buildall.cmake`
+
+Visual Studio 2005の場合は、cmakeのバージョン3.11.4以前を使用
+(cmake が libs\cmake-3.11.4-win32-x86 にインストールしてある場合)
+
+    libs\cmake-3.11.4-win32-x86\bin\cmake.exe" -DCMAKE_GENERATOR="Visual Studio 8 2005" -P buildall.cmake
+
+## MinGW 共通
+
+各々の環境のcmakeを使用する
+
+    cmake -DCMAKE_GENERATOR="Unix Makefiles" -P buildall.cmake
+
+# 各フォルダについて
+
+## 生成されるライブラリフォルダ
+
+- 次のフォルダにライブラリの `*.h` , `*.lib` が生成される
+	- `oniguruma_{compiler}`
+	- `openssl_{compiler}`
+	- `putty`
+	- `SFMT_{compiler}`
+	- `zlib_{compiler}`
+
+## download アーカイブダウンロードフォルダ
+
+- ダウンロードしたアーカイブファイルが置かれる
+- 自動でダウンロードされる
+- ダウンロードされていると再利用する
+- ビルド後、参照する必要がなければ削除できる
+
+## build ビルドフォルダ
+
+- `build/oniguruma/{compiler}/` などの下でビルドされる
+- 再ビルドするときは、あらかじめ削除すること
+- ビルド後、参照する必要がなければ削除できる

Modified: trunk/doc/ja/html/reference/build_with_cmake.md
===================================================================
--- trunk/doc/ja/html/reference/build_with_cmake.md	2019-04-09 16:23:23 UTC (rev 7564)
+++ trunk/doc/ja/html/reference/build_with_cmake.md	2019-04-09 16:23:39 UTC (rev 7565)
@@ -6,21 +6,20 @@
 ## cmakeのバージョン
 
 - Visual Studio 2005 をサポートしている cmake の最後のバージョンは 3.11.4 です
-- Visual Studio 2005 Express では ttpmacro.exe をビルドすることができません
 - Visual Studio 2005 (Expressも含む)以外を使用する場合は特に制限はありません
-- Visual Studio 2017 インストーラーで、オプションを選べば cmake をインストールできます
+- Visual Studio 2017,2019 インストーラーで、オプションを選べば cmake をインストールできます
+- cmake 3.14から Visual Studio 2019 をサポートしています
 
 ## MinGW (very experimental)
 
 - MinGW を使用してバイナリを生成することができます
 - 実験的位置づけです
-- MinGW では ttpmacro.exe をビルドすることができません
 
 ## ライブラリのビルド
 
 - teraterm が使用するライブラリをビルドして準備しておきます
-- `lib/build_library_with_cmake.md` を参照してください
-- ライブラリは `develop.txt` を参照してください
+- ビルド方法は [`build_library_with_cmake`](<build_library_with_cmake.html>) を参照してください
+- ライブラリについては [`develop.txt`](<develop.txt>) を参照してください
 
 ## teratermのビルド
 
@@ -37,7 +36,10 @@
 - 生成された sln ファイルから起動したVisual Studioでビルドすると
   CMakeLists.txt を変更を検出してプロジェクトファイルの再生成を自動で行うので
   sln ファイルの生成を手動で行うのは最初の1回だけです
+- Visual Studio 2019 + cmake のとき、`-A` オプションが必要です
 
+    cmake.exe .. -G "Visual Studio 16 2019" -A Win32
+
 ## teratermのビルド(MinGW)
 
 MinGWので使用できるcmakeを使って、

Modified: trunk/doc/ja/teraterm.hhc
===================================================================
--- trunk/doc/ja/teraterm.hhc	2019-04-09 16:23:23 UTC (rev 7564)
+++ trunk/doc/ja/teraterm.hhc	2019-04-09 16:23:39 UTC (rev 7565)
@@ -592,9 +592,20 @@
 		<UL>
 			<LI> <OBJECT type="text/sitemap">
 				<param name="Name" value="CMake\x83r\x83\x8B\x83h\x83V\x83X\x83e\x83\x80\x82\xF0\x8Eg\x97p\x82\xB5\x82\xBD\x83r\x83\x8B\x83h(experimental)">
-				<param name="Local" value="html\reference\build_with_cmake.html">
 				<param name="ImageNumber" value="11">
 				</OBJECT>
+			<UL>
+				<LI> <OBJECT type="text/sitemap">
+					<param name="Name" value="\x83\x89\x83C\x83u\x83\x89\x83\x8A\x82̃r\x83\x8B\x83h">
+					<param name="Local" value="html\reference\build_library_with_cmake.html">
+					<param name="ImageNumber" value="11">
+				  </OBJECT>
+				<LI> <OBJECT type="text/sitemap">
+					<param name="Name" value="Tera Term\x82̃r\x83\x8B\x83h">
+					<param name="Local" value="html\reference\build_with_cmake.html">
+					<param name="ImageNumber" value="11">
+				  </OBJECT>
+			</UL>
 		</UL>
 		<LI> <OBJECT type="text/sitemap">
 			<param name="Name" value="\x83\\x81[\x83X\x83R\x81[\x83h\x89\xF0\x90\xE0">

Modified: trunk/libs/build_library_with_cmake.md
===================================================================
--- trunk/libs/build_library_with_cmake.md	2019-04-09 16:23:23 UTC (rev 7564)
+++ trunk/libs/build_library_with_cmake.md	2019-04-09 16:23:39 UTC (rev 7565)
@@ -1,76 +1,2 @@
 
-# libフォルダ
-
-- teratermが利用する外部のライブラリをビルドするためのフォルダ
-- コンパイラ向けに各々ビルド
-- 1度ビルドしてライブラリを生成しておく
-
-# 準備
-
-## Visual Studio
-
-- cmake
-	- PATHが通してあればok
-	- cygwinのcmakeはつかえない(Visual Studioをサポートしていない)
-	- Visual Studio 2005 を使う場合は cmake 3.11.4 を使用する必要がある
-- perl
-	- OpenSSL のコンパイル、ドキュメントファイルの文字コード・改行コード変換に必要
-	- ActivePerl 5.8 以上、または cygwin perl
-	- PATHが通っていなければ自動で探す
-
-## MinGW 共通 (experimental)
-
-- Cygwin,MSYS2,linux(wsl)上のMinGWでビルド可能
-- 各環境で動作するcmake,make,(MinGW)gcc,perlが必要
-
-# ビルド手順
-
-必要なアーカイブを自動的にダウンロードするので、
-インターネットが利用できる環境でビルドする必要がある
-
-## Visual Studioの場合
-
-### batファイルを使用する場合
-
-- 自動的にビルド
-- buildall_cmake.bat を実行
-- コンパイルに使用する Visual Studioを選ぶ
-- VS2005の場合はcmake 3.11.4 をダウンロードして
-  libs\cmake-3.11.4-win32-x86 にインストールする
-
-### cmakeを使用する場合
-
-- cmakeを使える状態にしてcmakeを実行
-	- `cmake -DCMAKE_GENERATOR="Visual Studio 15 2017" -P buildall.cmake`
-	- `cmake -DCMAKE_GENERATOR="Visual Studio 15 2017 Win64" -P buildall.cmake`
-- Visual Studio 2005の場合は、cmakeのバージョン3.11.4以前を使用する
-	- cmake が libs\cmake-3.11.4-win32-x86 にインストールしてある場合  
-	  `"libs\cmake-3.11.4-win32-x86\bin\cmake.exe" -DCMAKE_GENERATOR="Visual Studio 8 2005" -P buildall.cmake`
-
-## MinGW 共通
-
-- 各々の環境のcmakeを使って
-  `cmake -DCMAKE_GENERATOR="Unix Makefiles" -P buildall.cmake` を実行
-
-# 各フォルダについて
-
-## 生成されるライブラリフォルダ
-
-- 次のフォルダにライブラリの`*.h`,`*.lib`が生成される
-	- oniguruma_{compiler}
-	- openssl_{compiler}
-	- putty
-	- SFMT_{compiler}
-	- zlib_{compiler}
-
-## download アーカイブダウンロードフォルダ
-
-- ダウンロードしたアーカイブファイルが置かれる
-- 自動でダウンロードされる
-- ダウンロードされていると再利用する
-- ビルド後、参照する必要がなければ削除できる
-
-## build ビルドフォルダ
-
-- build/oniguruma_{compiler}/ などの下でビルドされる
-- ビルド後、参照する必要がなければ削除できる
+Refer to the [build_library_with_cmake.md](<../doc/jp/html/reference/build_library_with_cmake.md>)


Ttssh2-commit メーリングリストの案内