summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorgithub-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>2021-03-25 00:17:22 +0000
committerGitHub <noreply@github.com>2021-03-25 00:17:22 +0000
commiteb499aa20e5fd100e24b4cb1d81f9ec3b0be979c (patch)
tree358e7ecf71ec3060da94211bcada5196744f0cb5 /doc
parent8e2d0e45c0ec8f752dd29c20dafec37dfe420437 (diff)
parentd9a1de3d608ef92141a4d45e39fb7257b39f637d (diff)
downloadnixpkgs-eb499aa20e5fd100e24b4cb1d81f9ec3b0be979c.tar
nixpkgs-eb499aa20e5fd100e24b4cb1d81f9ec3b0be979c.tar.gz
nixpkgs-eb499aa20e5fd100e24b4cb1d81f9ec3b0be979c.tar.bz2
nixpkgs-eb499aa20e5fd100e24b4cb1d81f9ec3b0be979c.tar.lz
nixpkgs-eb499aa20e5fd100e24b4cb1d81f9ec3b0be979c.tar.xz
nixpkgs-eb499aa20e5fd100e24b4cb1d81f9ec3b0be979c.tar.zst
nixpkgs-eb499aa20e5fd100e24b4cb1d81f9ec3b0be979c.zip
Merge master into staging-next
Diffstat (limited to 'doc')
-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" />