docs/ja-jp/build/html/_sources/ringpm.txt

   1 .. index::
   2         single: Ring パッケージ管理プログラム (RingPM); はじめに
   3
   4 ======================================
   5 Ring パッケージ管理プログラム (RingPM)
   6 ======================================
   7
   8 Ring パッケージ管理プログラム (RingPM) の用法を学びます。
   9
  10 RingPM ツールは Ring パッケージの検索、インストール、および更新をします。
  11
  12
  13 .. index::
  14         pair: Ring パッケージ管理プログラム (RingPM); 特徴
  15
  16 特徴
  17 ====
  18
  19 パッケージ管理プログラムではパッケージ間の互換性確認のために意味つきバージョン管理を使用しています。
  20
  21 このようなオプションがパッケージ管理プログラムにあります。
  22
  23 .. code-block:: none
  24
  25         用法 : ringpm [コマンド]
  26         コマンド : search  [キーワード...]
  27         コマンド : refresh : レジストリの更新 (パッケージリスト)
  28         コマンド : install [ <パッケージ名> [from <ユーザ名>] [branch <ブランチ名>] ]
  29         コマンド : list    [-u : 更新の確認]
  30         コマンド : run     [パッケージ名]
  31         コマンド : update  <パッケージ名>
  32         コマンド : remove  <パッケージ名>
  33         コマンド : format  : すべてのパッケージを削除
  34         コマンド : new     <パッケージ名>
  35         コマンド : package : 現在のフォルダにパッケージを作成
  36
  37 .. index::
  38         pair: Ring パッケージ管理プログラム (RingPM); パッケージの検索
  39
  40 パッケージの検索
  41 ================
  42
  43 新しいパッケージを検索するには Search コマンドを使用します。
  44
  45 このコマンドは RingPM レジストリ (パッケージのインデックス) を検索します。
  46
  47 RingPM レジストリは登録済み全パッケージのローカルコピーです。
  48
  49 .. code-block:: none
  50
  51         ringpm search [キーワード...]
  52
  53 用例:
  54
  55 .. code-block:: none
  56
  57         ringpm search notepad
  58
  59 実行結果:
  60
  61 .. code-block:: none
  62
  63         Package : ringnotepad (Ring Notepad)
  64         Package : notepadppeditorextension (Notepad++ Editor Extension package)
  65
  66 RingPM レジストリにある全パッケージを表示するには、キーワード無指定で Search コマンドを使用してください。
  67
  68 用例:
  69
  70 .. code-block:: none
  71
  72         ringpm search
  73
  74 .. index::
  75         pair: Ring パッケージ管理プログラム (RingPM); RingPM レジストリの更新
  76
  77 RingPM レジストリの更新
  78 =======================
  79
  80 RingPM レジストリは登録済み全パッケージのローカルコピーです。
  81
  82 ローカルコピーを更新するには Refresh コマンドを使用します。
  83
  84 用例:
  85
  86 .. code-block:: none
  87
  88         ringpm refresh
  89
  90 実行結果:
  91
  92 .. code-block:: none
  93
  94         No updates to the Registry, Nothing to do!
  95
  96 または
  97
  98 .. code-block:: none
  99
 100         The Registry is updated from revision 110 (2019/01/13) to revision 112 (2019/01/15)
 101
 102 .. index::
 103         pair: Ring パッケージ管理プログラム (RingPM); パッケージのインストール
 104
 105 パッケージのインストール
 106 ========================
 107
 108
 109 新しいパッケージをインストールするには Install コマンドを使用します。
 110
 111 .. code-block:: none
 112
 113         ringpm install [ <パッケージ名> [from <ユーザ名>] [branch <ブランチ名>] ]
 114
 115 RingPM レジストリからパッケージ情報を取得するには、パッケージ名のみ打鍵します。
 116 または、ユーザ名 (GitHub) と GitHub プロジェクトのブランチ名を決定します。
 117
 118 カレントフォルダがパッケージフォルダならば、パッケージ名の記述は不要です。
 119
 120 用例 (1) :
 121
 122 .. code-block:: none
 123
 124         ringpm install ringnotepad
 125
 126 用例 (2) :
 127
 128 .. code-block:: none
 129
 130         ringpm install goldmagic800
 131
 132 用例 (3) :
 133
 134 .. code-block:: none
 135
 136         ringpm install gameoflife
 137
 138 RingPM レジストリにパッケージが追加されていない場合は、 GitHub ユーザから直接インストールできます
 139
 140 用例 (4) :
 141
 142 .. code-block:: none
 143
 144         ringpm install firstpackage from mahmoudfayed
 145
 146 インストール後にパッケージを実行するには
 147
 148 .. code-block:: none
 149
 150         ringpm run firstpackage
 151
 152 カレントフォルダへパッケージをインストールするには
 153
 154 用例 (5) :
 155
 156 .. code-block:: none
 157
 158         ringpm install
 159
 160 .. index::
 161         pair: Ring パッケージ管理プログラム (RingPM); インストール済みパッケージのリスト表示
 162
 163 インストール済みパッケージのリスト表示
 164 ======================================
 165
 166 インストール済みパッケージを確認するには List コマンドを使用します。
 167
 168 .. code-block:: none
 169
 170         ringpm list [-u : 更新の確認]
 171
 172 用例:
 173
 174 .. code-block:: none
 175
 176         ringpm list
 177
 178 実行結果:
 179
 180 .. code-block:: none
 181
 182         (analogclock)          : The AnalogClock Package [master]         -- (1.0.0)
 183         (androidringlibsdl)    : The AndroidRingLibSDL Package [master]   -- (1.0.0)
 184         (androidringqt)        : The AndroidRingQt Package [master]       -- (1.0.0)
 185         (atomeditorextension)  : The AtomEditorExtension Package [master] -- (1.0.0)
 186         (bignumber)            : The BigNumber Package [master]           -- (1.0.0)
 187         (calculator)           : The Calculator Package [master]          -- (1.0.0)
 188         (cards)                : The Cards Package [master]               -- (1.0.0)
 189         (checkers)             : The Checkers Package [master]            -- (1.0.0)
 190         (chess)                : The Chess Package [master]               -- (1.0.0)
 191         ....
 192
 193 新しい更新を確認するには
 194
 195 .. code-block:: none
 196
 197         ringpm list -u
 198
 199 .. index::
 200         pair: Ring パッケージ管理プログラム (RingPM); パッケージの実行
 201
 202 パッケージの実行
 203 ================
 204
 205 インストール後にパッケージを実行するには Run コマンドを使用します。
 206
 207 .. code-block:: none
 208
 209         ringpm run [パッケージ名]
 210
 211 用例(1):
 212
 213 .. code-block:: none
 214
 215         ringpm run ringnotepad
 216
 217 用例(2):
 218
 219 .. code-block:: none
 220
 221         ringpm run goldmagic800
 222
 223 用例(3):
 224
 225 .. code-block:: none
 226
 227         ringpm run gameoflife
 228
 229 カレントフォルダでパッケージを実行するには
 230
 231 用例(4):
 232
 233 .. code-block:: none
 234
 235         ringpm run
 236
 237 .. index::
 238         pair: Ring パッケージ管理プログラム (RingPM); パッケージの更新
 239
 240 パッケージの更新
 241 ================
 242
 243 パッケージを更新するには Update コマンドを使用します。
 244
 245 .. code-block:: none
 246
 247         ringpm update <パッケージ名>
 248
 249 用例:
 250
 251 .. code-block:: none
 252
 253         ringpm update ringnotepad
 254
 255 .. index::
 256         pair: Ring パッケージ管理プログラム (RingPM); パッケージの削除
 257
 258 パッケージの削除
 259 ================
 260
 261 パッケージを削除するには Remove コマンドを使用します。
 262
 263 .. code-block:: none
 264
 265         ringpm remove <パッケージ名>
 266
 267 用例:
 268
 269 .. code-block:: none
 270
 271         ringpm remove ringnotepad
 272
 273 .. index::
 274         pair: Ring パッケージ管理プログラム (RingPM); パッケージの全削除
 275
 276 パッケージの全削除
 277 ==================
 278
 279 全てのパッケージを削除するには Format コマンドを使用します。
 280
 281 用例:
 282
 283 .. code-block:: none
 284
 285         ringpm format
 286
 287
 288 .. index::
 289         pair: Ring パッケージ管理プログラム (RingPM); パッケージの新規作成
 290
 291 パッケージの新規作成
 292 ====================
 293
 294 パッケージを新規作成するには New コマンドを使用します。
 295
 296 .. code-block:: none
 297
 298         ringpm new <パッケージ名>
 299
 300 用例:
 301
 302 .. code-block:: none
 303
 304         ringpm new myapp
 305
 306 これは新しいフォルダ myapp を作成します。
 307
 308 このようなファイルが新しいフォルダにあります。
 309
 310 * package.ring : パッケージの概要とファイル
 311 * main.ring : メインプログラム (Run コマンドで使用)
 312 * lib.ring : パッケージと関連するライブラリファイル
 313
 314 ファイル : main.ring
 315
 316 .. code-block:: ring
 317
 318         # メインファイル
 319
 320         load "lib.ring"
 321
 322         func main
 323
 324                 ? "Hello, World!"
 325
 326
 327 ファイル : lib.ring
 328
 329 .. code-block:: ring
 330
 331         # ライブラリファイル
 332
 333 ファイル : package.ring
 334
 335 .. code-block:: ring
 336
 337         aPackageInfo = [
 338                 :name = "The myapp Package",
 339                 :description = "Our myapp package using the Ring programming language",
 340                 :folder = "myapp",
 341                 :developer = "",
 342                 :email = "",
 343                 :license = "MIT License",
 344                 :version = "1.0.0",
 345                 :ringversion = "1.10",
 346                 :versions =     [
 347                         [
 348                                 :version = "1.0.0",
 349                                 :branch = "master"
 350                         ]
 351                 ],
 352                 :libs =         [
 353                         [
 354                                 :name = "",
 355                                 :version = "",
 356                                 :providerusername = ""
 357                         ]
 358                 ],
 359                 :files =        [
 360                         "lib.ring",
 361                         "main.ring"
 362                 ],
 363                 :ringfolderfiles =      [
 364
 365                 ],
 366                 :windowsfiles =         [
 367
 368                 ],
 369                 :linuxfiles =   [
 370
 371                 ],
 372                 :ubuntufiles =  [
 373
 374                 ],
 375                 :fedorafiles =  [
 376
 377                 ],
 378                 :macosfiles =   [
 379
 380                 ],
 381                 :windowsringfolderfiles =       [
 382
 383                 ],
 384                 :linuxringfolderfiles =         [
 385
 386                 ],
 387                 :ubunturingfolderfiles =        [
 388
 389                 ],
 390                 :fedoraringfolderfiles =        [
 391
 392                 ],
 393                 :macosringfolderfiles =         [
 394
 395                 ],
 396                 :run = "ring main.ring",
 397                 :windowsrun = "",
 398                 :linuxrun = "",
 399                 :macosrun = "",
 400                 :ubunturun = "",
 401                 :fedorarun = "",
 402                 :setup = "",
 403                 :windowssetup = "",
 404                 :linuxsetup = "",
 405                 :macossetup = "",
 406                 :ubuntusetup = "",
 407                 :fedorasetup = "",
 408                 :remove = "",
 409                 :windowsremove = "",
 410                 :linuxremove = "",
 411                 :macosremove = "",
 412                 :ubunturemove = "",
 413                 :fedoraremove = ""
 414         ]
 415
 416 .. index::
 417         pair: Ring パッケージ管理プログラム (RingPM); パッケージ概要ファイル
 418
 419 パッケージ概要ファイル
 420 ======================
 421
 422 パッケージ概要ファイルには、 aPackageInfo のリストで定義されたパッケージ情報があります。
 423
 424 ======================= =================================================================================
 425 属性                  説明
 426 ======================= =================================================================================
 427 Name                    パッケージ名
 428 Description             パッケージの概要
 429 Folder                  フォルダ名 (ring/ringpm/packages へ作成されます)
 430 Developer               パッケージ開発者名
 431 Email                   パッケージ開発者の電子メールアドレス
 432 License                 パッケージの使用許諾条件
 433 Version                 パッケージの現行バージョン (最新版数)
 434 RingVersion             必要とされる Ring 言語のバージョン (最小版数)
 435 Versions                GitHub プロジェクトの別ブランチにより提示されるバージョンのリスト
 436 Libs                    依存性リスト (名前、バージョンと GitHub のユーザ名)
 437 Files                   ファイルリスト (ring/ringpm/packages/[フォルダ] へインストールされます)
 438 RingFolderFiles         ファイルリスト (Ring のフォルダへインストールされます)
 439 WindowsFiles            Files と同じですが Microsoft Windows のみで行う処理を指定
 440 LinuxFiles              Files と同じですが Linux のみで行う処理を指定
 441 MacOSFiles              Files と同じですが macOS のみで行う処理を指定
 442 UbuntuFiles             Files と同じですが Ubuntu のみで行う処理を指定
 443 FedoraFiles             Files と同じですが Fedora のみで行う処理を指定
 444 WindowsRingFolderFiles  RingFolderFiles と同じですが Microsoft Windows のみで行う処理を指定
 445 LinuxRingFolderFiles    RingFolderFiles と同じですが Linux のみで行う処理を指定
 446 MacOSRingFolderFiles    RingFolderFiles と同じですが macOS のみで行う処理を指定
 447 UbuntuRingFolderFiles   RingFolderFiles と同じですが Ubuntu のみで行う処理を指定
 448 FedoraRingFolderFiles   RingFolderFiles と同じですが Fedora のみで行う処理を指定
 449 Run                     パッケージで実行するシステムコマンド (コマンドプロンプトまたは端末)
 450 WindowsRun              Run と同じですが Microsoft Windows のみで行う処理を指定
 451 LinuxRun                Run と同じですが Linux のみで行う処理を指定
 452 MacOSRun                Run と同じですが macOS のみで行う処理を指定
 453 UbuntuRun               Run と同じですが Ubuntu のみで行う処理を指定
 454 FedoraRun               Run と同じですが Fedora のみで行う処理を指定
 455 Setup                   パッケージファイルのダウンロード後に実行するシステムコマンド (コマンドプロンプトまたは端末)
 456 WindowsSetup            Setup と同じですが Microsoft Windows のみで行う処理を指定
 457 LinuxSetup              Setup と同じですが Linux のみで行う処理を指定
 458 MacOSSetup              Setup と同じですが macOS のみで行う処理を指定
 459 UbuntuSetup             Setup と同じですが Ubuntu のみで行う処理を指定
 460 FedoraSetup             Setup と同じですが Fedora のみで行う処理を指定
 461 Remove                  パッケージファイルの削除前に実行するシステムコマンド (コマンドプロンプトまたは端末)
 462 WindowsRemove           Remove と同じですが Microsoft Windows のみで行う処理を指定
 463 LinuxRemove             Remove と同じですが Linux のみで行う処理を指定
 464 MacOSRemove             Remove と同じですが macOS のみで行う処理を指定
 465 UbuntuRemove            Remove と同じですが Ubuntu のみで行う処理を指定
 466 FedoraRemove            Remove と同じですが Fedora のみで行う処理を指定
 467 ======================= =================================================================================
 468
 469
 470
 471 .. index::
 472         pair: Ring パッケージ管理プログラム (RingPM); カレントフォルダでのパッケージ作成
 473
 474 カレントフォルダでのパッケージ作成
 475 ==================================
 476
 477 既存アプリケーションでパッケージを作成するには、このコマンドをアプリケーションのフォルダへ移動後に実行します。
 478
 479 .. code-block:: none
 480
 481         ringpm package
 482
 483 これは、パッケージ定義ファイル (package.ring) の作成を行い、パッケージ定義へアプリケーションのファイルを全追加します。
 484
 485 RingPM で作成したパッケージには、パッケージ情報とファイルリストを記したパッケージ定義ファイル (package.ring) が収録されています。
 486
 487 用例:
 488
 489 「Ring ノートパッド」パッケージのパッケージファイル定義は
 490
 491 .. code-block:: ring
 492
 493         aPackageInfo = [
 494                 :name = "The RingNotepad Package",
 495                 :description = "Our RingNotepad package using the Ring programming language",
 496                 :folder = "ringnotepad",
 497                 :developer = "Mahmoud Fayed",
 498                 :email = "msfclipper@yahoo.com",
 499                 :license = "MIT License",
 500                 :version = "1.0.0",
 501                 :ringversion = "1.10",
 502                 :versions =     [
 503                         [
 504                                 :version = "1.0.0",
 505                                 :branch = "master"
 506                         ]
 507                 ],
 508                 :libs =         [
 509                         [
 510                                 :name = "stdlib",
 511                                 :version = "1.0",
 512                                 :providerusername = ""
 513                         ],
 514                         [
 515                                 :name = "ringqt",
 516                                 :version = "1.0",
 517                                 :providerusername = ""
 518                         ],
 519                         [
 520                                 :name = "findinfiles",
 521                                 :version = "1.0",
 522                                 :providerusername = ""
 523                         ],
 524                         [
 525                                 :name = "formdesigner",
 526                                 :version = "1.0",
 527                                 :providerusername = ""
 528                         ],
 529                         [
 530                                 :name = "libdepwin_apache",
 531                                 :version = "1.0",
 532                                 :providerusername = ""
 533                         ]
 534                 ],
 535                 :files =        [
 536                         "main.ring",
 537                         "README.md"
 538                 ],
 539                 :ringfolderfiles =      [
 540                         "applications/rnote/batch/killwebserver.bat",
 541                         "applications/rnote/batch/run.bat",
 542                         "applications/rnote/batch/run2.bat",
 543                         "applications/rnote/image/back.jpg",
 544                         "applications/rnote/image/back2.jpg",
 545                         "applications/rnote/image/close.png",
 546                         "applications/rnote/image/colors.png",
 547                         "applications/rnote/image/copy.png",
 548                         "applications/rnote/image/cut.png",
 549                         "applications/rnote/image/debug.png",
 550                         "applications/rnote/image/font.png",
 551                         "applications/rnote/image/formdesigner.png",
 552                         "applications/rnote/image/new.png",
 553                         "applications/rnote/image/notepad.png",
 554                         "applications/rnote/image/open.png",
 555                         "applications/rnote/image/paste.png",
 556                         "applications/rnote/image/print.png",
 557                         "applications/rnote/image/project.png",
 558                         "applications/rnote/image/richtext.png",
 559                         "applications/rnote/image/run.png",
 560                         "applications/rnote/image/rungui.png",
 561                         "applications/rnote/image/save.png",
 562                         "applications/rnote/image/saveas.png",
 563                         "applications/rnote/image/search.png",
 564                         "applications/rnote/image/source.png",
 565                         "applications/rnote/image/undo.png",
 566                         "applications/rnote/image/web.png",
 567                         "applications/rnote/README.md",
 568                         "applications/rnote/rnote.ring",
 569                         "applications/rnote/rnoteactivefile.ring",
 570                         "applications/rnote/rnoteactivefolder.ring",
 571                         "applications/rnote/rnoteautocomplete.ring",
 572                         "applications/rnote/rnotebase.ring",
 573                         "applications/rnote/rnotecontroller.ring",
 574                         "applications/rnote/rnotedistribute.ring",
 575                         "applications/rnote/rnoteeditmenu.ring",
 576                         "applications/rnote/rnoteeditorevents.ring",
 577                         "applications/rnote/rnotefilemenu.ring",
 578                         "applications/rnote/rnotefiles.ring",
 579                         "applications/rnote/rnotefilestabs.ring",
 580                         "applications/rnote/rnotefind.ring",
 581                         "applications/rnote/rnotefindinfiles.ring",
 582                         "applications/rnote/rnoteformdesigner.ring",
 583                         "applications/rnote/rnotegoto.ring",
 584                         "applications/rnote/rnotehelp.ring",
 585                         "applications/rnote/rnotelists.ring",
 586                         "applications/rnote/rnotemainfiletoolbar.ring",
 587                         "applications/rnote/rnotemainwindow.ring",
 588                         "applications/rnote/rnotemode.ring",
 589                         "applications/rnote/rnoteoutputwindow.ring",
 590                         "applications/rnote/rnoteprogrammenu.ring",
 591                         "applications/rnote/rnoterun.ring",
 592                         "applications/rnote/rnotesettings.ring",
 593                         "applications/rnote/rnotestyle.ring",
 594                         "applications/rnote/rnotetabwidth.ring",
 595                         "applications/rnote/rnotetools.ring",
 596                         "applications/rnote/rnotetreeviewevents.ring",
 597                         "applications/rnote/rnoteviewmenu.ring",
 598                         "applications/rnote/rnotewebbrowser.ring"
 599                 ],
 600                 :run = "ring main.ring"
 601         ]
 602
 603 .. index::
 604         pair: Ring パッケージ管理プログラム (RingPM); RingPM レジストリファイル
 605
 606 RingPM レジストリファイル
 607 =========================
 608
 609 RingPM レジストリは、登録済み全パッケージのローカルコピーです。
 610
 611 .. code-block:: ring
 612
 613         aPackagesRegistry = [
 614                 [ :name = "ringpresentation",
 615                   :description = "Powerpoint presentation for the Ring programming language",
 616                   :ProviderUserName = "ringpackages"
 617                 ]
 618                 # ...
 619         ]
 620
 621 このリストでパッケージを定義しています。
 622
 623 * パッケージ名
 624 * パッケージの概要
 625 * 開発者のユーザ名 (GitHub ユーザ名)
 626
 627 新しいパッケージを登録するには、レジストリファイルを更新後に Pull リクエストを送信します。
 628
 629 URL : https://github.com/ring-lang/ring/blob/master/ringpm/registry/registry.ring
 630