FLATPAK-DOCUMENT-EXPORT(1)

πŸ’… flatpak-document-export β€” bestie edition

okay so this is the manual page for flatpak-document-export from the flatpak command family β€” she lives in section 1 of the man pages, and honestly? she's kind of a baddie. let's get into it ✨


πŸŽ€ NAME πŸŽ€

flatpak-document-export β€” export a file to a sandboxed application 🫢


✨ SYNOPSIS ✨

flatpak document-export [OPTION...] FILE

one file, a whole pile of options if you want them. that's the whole vibe. πŸ’…


🌸 DESCRIPTION 🌸

So what she does is: she creates a document id for a local file, and that id can be exposed to sandboxed applications. Translation? It lets those apps see files they would NOT otherwise see. no cap. the exported files get exposed in a fuse filesystem at:

/run/user/$UID/doc/

πŸ‘‘ iconic behavior honestly.

And she's not just a one-trick pony β€” this command also lets you modify the per-application permissions of the documents. so you can grant or revoke access to the file, on a per-application basis. like a little permission bouncer at the door. πŸšͺ✨


πŸ’– OPTIONS πŸ’–

The following options are understood:

  • -h, --help β€” shows you the help options and dips. that's it, that's the whole job. πŸ™ˆ
  • -u, --unique β€” don't reuse an existing document id for the file. this is the one you want if you're planning to remove the document later once you're done with it, because it's safe to do that. 🫢
  • -t, --transient β€” the document will only exist for the length of the session. perfect for temporary grants, like a lil pop-up shop but for permissions. πŸ¦‹
  • -n, --noexist β€” don't require the file to exist already. she's flexible like that. πŸ’…
  • -a, --app=APPID β€” grant read access to the specified application. the --allow and --forbid options can be used to grant or remove additional privileges. and yes bestie, this option can be used multiple times β€” stack her up. πŸ”₯
  • -r, --allow-read β€” grant read access to the applications specified with --app. this defaults to TRUE. ⭐
  • --forbid-read β€” revoke read access for the applications specified with --app. bye bye read privileges πŸ’€
  • -w, --allow-write β€” grant write access to the applications specified with --app. ✍️
  • --forbid-write β€” revoke write access for the applications specified with --app. ✍️🚫
  • -d, --allow-delete β€” grant the ability to remove the document from the document portal to the applications specified with --app. πŸ—‘οΈβœ¨
  • --forbid-delete β€” revoke the ability to remove the document from the document portal from the applications specified with --app. no deleting for you πŸ—‘οΈπŸš«
  • -g, --allow-grant-permission β€” grant the ability to grant further permissions to the applications specified with --app. permission to give permission, very meta, very main character. πŸ‘‘
  • --forbid-grant-permission β€” revoke the ability to grant further permissions for the applications specified with --app. 🚫
  • -v, --verbose β€” print debug information during command processing. the tea β˜•
  • --ostree-verbose β€” print OSTree debug information during command processing. extra tea, specifically ostree-flavored 🧚

🌈 EXAMPLES 🌈

look at her go:

$ flatpak document-export --app=org.gnome.gedit ~/test.txt

and she gives you back:

/run/user/1000/doc/e52f9c6a/test.txt

ate. no crumbs. πŸ“


πŸ‘‘ SEE ALSO πŸ‘‘

flatpak(1), flatpak-document-unexport(1), flatpak-document-info(1), flatpak-documents(1)


and that's the whole page bestie, go export some documents, you're literally built for this πŸ’œ

this one came from the flatpak source, section 1 of the manuals, dated like all the other flatpak pages β€” mwah, love her, bye πŸŽ€πŸ¦‹βœ¨

πŸ“¦ where this page comes from