Top / EBUG勉強会 / 20210828_FuguItaDocument

河豚板のドキュメント

EBUG 第78回会合(オンライン)
2021年8月28日
川俣吉広、kaw@on.rim.or.jp

河豚板は公式サイト fuguita.org 上で河豚板固有のドキュメントを公開している。
本文書ではこれらのドキュメントの目的とその内容について紹介する。

ドキュメントなしで河豚板を使用する

河豚板を利用するユーザの中には、河豚板を単に「インストール作業なしで使えるOpenBSD」として利用するケースがあることが考えられる。

河豚板は柔軟な運用を行えるようにするためネットワークをはじめとする各種設定は起動時にユーザが入力するようになっている。これらの設定を問題なく行えるようにするため、入力部分は以下のような方針で設計されている。

  • 自己説明的なユーザ・インターフェース
    Unix系OSについてある程度知識のあるユーザであれば予備知識なしでも設定値を入力できるように、必要十分な説明を表示する。
  • 適切なデフォルト
    適切な入力値が存在する場合はデフォルトとして提示し、ENTERのみの入力ですませられる。

ログイン後の環境も、ファイルシステム以外はVanillaなOpenBSDとほとんど同じであるので、単純にOpenBSDとして使うのであれば、man pageなど通常のドキュメントでOK。

ただし、河豚板特有の機能を利用する場合は、当然それらを説明したドキュメントを参照する必要がある。

OpenBSD != FuguItaな部分については?

河豚板はVanilla OpenBSDに、以下の機能が追加されている。

  • LiveDVDのリマスタリング
  • LiveUSBのリマスタリングとカスタマイズ
    Legacy BIOS/UEFIの選択、暗号化パーティションの作成等
  • インスタンスのUSBメモリへの保存と次回起動時での復帰
  • 非対話的起動
  • デスクトップと日本語環境の導入ツール
  • ネットワーク設定の on the fly での切り替え
  • ライブアップデータ
  • etc ...

これらの機能を利用するために、次項で説明するドキュメント類が公開されている。

河豚板独自のドキュメント

  • 概要の説明と活用事例の紹介
  • 導入ガイド
  • FuguIta Start Guide (英語)
    ダウンロード・メディア作成からデスクトップ環境設定までを一通り説明
    ... 全てのユーザに読んで欲しいので英語表記。日本語版は用意されていないが、自動翻訳を用いることで内容を把握できる。
    文書の最後に次項で説明する「河豚板ガイド」の英訳目次を添付しており、さらに詳しい情報へのポインタとなっている。
  • 包括的な資料
  • 河豚板ガイド (日本語)
    ダウンロード元の紹介からセルフビルドまで全部入りの資料
    ... そこそこのボリュームがあるので、日本語版のみ(本当は英語版も提供したいが...)。
  • その他
  • 掲示板
    ユーザからの質問や要望などのサポートもこちらで行っている。
    また、試験的、あるいは新しく導入された機能などの記事が投稿される。河豚板の利用事例紹介やユーザからの質問に即した解説などもある。
  • 3rd partyの資料
    fuguita.org内の公式資料以外にも、ユーザなどによって作成された解説資料やレビュー記事などがインターネット上に公開されている。いくつか例を挙げてみる。

Top / EBUG勉強会 / 20210828_FuguItaDocument

Reload  New Edit Freeze Diff Attach Copy Rename  Top Index Search Recent Backups  Help  RSS
Last-modified: 2021-08-28 (Sat) 14:34:21 (22d)