Difference between revisions of "Documentation"

From OpenZFS
Jump to: navigation, search
(General documentation aimed at users / system administrators)
(Move user/sysadmin documentation to its own page.)
 
Line 1: Line 1:
== General documentation aimed at users / system administrators ==
+
== [[System Administration | General documentation aimed at users / system administrators]] ==
* [[Features]]
+
* [[Publications | Publications and conference talks]]
+
* [[History]]
+
* [[Performance tuning]]
+
* Manual pages: [http://illumos.org/man/1m/zdb zdb] | [http://illumos.org/man/1m/zfs zfs] | [http://illumos.org/man/1m/zpool zpool] | [http://illumos.org/man/5/zpool-features zpool-features] | [http://illumos.org/man/1m/zstreamdump zstreamdump] – ''from illumos; better-rendered pages would be appreciated''
+
* [http://docs.oracle.com/cd/E26505_01/html/E37384/index.html Oracle Solaris ZFS Administration Guide] – largely applicable
+
* [http://www.snia.org/sites/default/files2/sdc_archives/2008_presentations/monday/JeffBonwick-BillMoore_ZFS.pdf ZFS – The Last Word in File Systems] – an overview from SNIA 2008
+
* [http://kateleyco.com/?page_id=783 Video tutorials from Kateley Co]
+
* [http://blog.delphix.com/matt/2014/06/06/zfs-stripe-width/ RAID-Z stripe width]
+
* [http://wintelguy.com/raidcalc.pl RAID-Z calculation tool] - includes RAID-Z1/Z2/Z3 calculations
+
* Applicable to most platforms, but maybe outdated:
+
** [http://www.solarisinternals.com/wiki/index.php/ZFS_Best_Practices_Guide ZFS Best Practices Guide]
+
** [http://www.solarisinternals.com/wiki/index.php/ZFS_Configuration_Guide ZFS Configuration Guide]
+
** [http://www.solarisinternals.com/wiki/index.php/ZFS_Evil_Tuning_Guide ZFS Evil Tuning Guide]
+
 
+
== Distribution-specific user documentation ==
+
=== FreeBSD ===
+
* Manual pages: [http://www.freebsd.org/cgi/man.cgi?query=zdb&manpath=FreeBSD+8.4-RELEASE zdb] | [http://www.freebsd.org/cgi/man.cgi?query=zfs&manpath=FreeBSD+8.4-RELEASE zfs] | [http://www.freebsd.org/cgi/man.cgi?query=zpool&manpath=FreeBSD+8.4-RELEASE zpool] | [http://www.freebsd.org/cgi/man.cgi?query=zpool-features&manpath=FreeBSD+8.4-RELEASE zpool-features] | [http://www.freebsd.org/cgi/man.cgi?query=zstreamdump&manpath=FreeBSD+8.4-RELEASE zstreamdump]
+
* [https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/zfs.html ZFS Chapter] of ''The FreeBSD Handbook''
+
* [https://wiki.freebsd.org/ZFS FreeBSD ZFS Wiki]
+
 
+
=== Gentoo ===
+
* [https://wiki.gentoo.org/wiki/ZFS Wiki page]
+
* [https://github.com/ryao/zfs-overlay/blob/master/zfs-install Richard Yao's Gentoo installation notes]
+
 
+
=== illumos ===
+
* Manual pages: [http://www.illumos.org/man/1m/zdb zdb] | [http://illumos.org/man/1m/zfs zfs] | [https://www.illumos.org/man/1M/zpool zpool] | [https://www.illumos.org/man/5/zpool-features zpool-features] | [http://illumos.org/man/1m/zstreamdump zstreamdump]
+
* [http://wiki.illumos.org/display/illumos/ZFS Wiki page]
+
* OpenIndiana [http://wiki.openindiana.org/oi/ZFS ZFS Administration Guide]
+
  
 
== [[Developer resources | Implementation documentation for developers]] ==
 
== [[Developer resources | Implementation documentation for developers]] ==

Latest revision as of 16:45, 6 August 2015

General documentation aimed at users / system administrators

Implementation documentation for developers