summary refs log tree commit diff
path: root/doc/builders
diff options
context:
space:
mode:
authormidchildan <git@midchildan.org>2021-03-24 02:22:15 +0900
committermidchildan <git@midchildan.org>2021-03-24 02:22:15 +0900
commitb67362d7f70a989a6f4bf6bb106207f53f0c6fe4 (patch)
tree2b881fd4a4ae18246ce8c28d81ac47e628dfdbee /doc/builders
parentc595604bed30d4e6a63ec1d20ba430897ebda653 (diff)
downloadnixpkgs-b67362d7f70a989a6f4bf6bb106207f53f0c6fe4.tar
nixpkgs-b67362d7f70a989a6f4bf6bb106207f53f0c6fe4.tar.gz
nixpkgs-b67362d7f70a989a6f4bf6bb106207f53f0c6fe4.tar.bz2
nixpkgs-b67362d7f70a989a6f4bf6bb106207f53f0c6fe4.tar.lz
nixpkgs-b67362d7f70a989a6f4bf6bb106207f53f0c6fe4.tar.xz
nixpkgs-b67362d7f70a989a6f4bf6bb106207f53f0c6fe4.tar.zst
nixpkgs-b67362d7f70a989a6f4bf6bb106207f53f0c6fe4.zip
doc: add section for FUSE
Diffstat (limited to 'doc/builders')
-rw-r--r--doc/builders/packages/fuse.section.md19
-rw-r--r--doc/builders/packages/index.xml1
2 files changed, 20 insertions, 0 deletions
diff --git a/doc/builders/packages/fuse.section.md b/doc/builders/packages/fuse.section.md
new file mode 100644
index 00000000000..5603481115e
--- /dev/null
+++ b/doc/builders/packages/fuse.section.md
@@ -0,0 +1,19 @@
+# FUSE {#sec-fuse}
+
+Some packages rely on
+[FUSE](https://www.kernel.org/doc/html/latest/filesystems/fuse.html) to provide
+support for additional filesystems not supported by the kernel.
+
+In general, FUSE software are primarily developed for Linux but many of them can
+also run on macOS. Nixpkgs supports FUSE packages on macOS, but it requires
+[macFUSE](https://osxfuse.github.io) to be installed outside of Nix. macFUSE
+currently isn't packaged in Nixpkgs mainly because it includes a kernel
+extension, which isn't supported by Nix outside of NixOS.
+
+If a package fails to run on macOS with an error message similar to the
+following, it's a likely sign that you need to have macFUSE installed.
+
+    dyld: Library not loaded: /usr/local/lib/libfuse.2.dylib
+    Referenced from: /nix/store/w8bi72bssv0bnxhwfw3xr1mvn7myf37x-sshfs-fuse-2.10/bin/sshfs
+    Reason: image not found
+    [1]    92299 abort      /nix/store/w8bi72bssv0bnxhwfw3xr1mvn7myf37x-sshfs-fuse-2.10/bin/sshfs
diff --git a/doc/builders/packages/index.xml b/doc/builders/packages/index.xml
index e1e2fef3f16..9653bae472d 100644
--- a/doc/builders/packages/index.xml
+++ b/doc/builders/packages/index.xml
@@ -12,6 +12,7 @@
  <xi:include href="emacs.section.xml" />
  <xi:include href="firefox.section.xml" />
  <xi:include href="fish.section.xml" />
+ <xi:include href="fuse.section.xml" />
  <xi:include href="ibus.section.xml" />
  <xi:include href="kakoune.section.xml" />
  <xi:include href="linux.section.xml" />