KSMBD.ADDSHARE(8)

πŸ’– KSMBD.ADDSHARE β€” the girlies' guide (8) πŸ’–

okay so bestie, this is ksmbd.addshare, and it lives in the System Administration section of the manual. it's the little tool that sets up shares for ksmbd.conf(5), which is the config file for the ksmbd.mountd(8) daemon. let's get into it ✨


🌸 NAME 🌸

ksmbd.addshare β€” configure shares for ksmbd.conf of ksmbd.mountd

like. that's literally its whole job. she configures. she slays. πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

ksmbd.addshare [-v] [-C CONF] [-P PWDDB] [-a | -u | -d] [-o OPT]... SHARE

look at her. one line. iconic. πŸ‘‘


✨ DESCRIPTION ✨

so ksmbd.addshare configures shares for the ksmbd.conf(5) configuration file that belongs to the ksmbd.mountd(8) user mode daemon. bestie that's the whole vibe.

⚠️ heads up though: ksmbd.addshare modifies ksmbd.conf in a way that does not retain its existing formatting. so like, your pretty hand-aligned comments? gone. she's doing a glow-up whether you asked or not. 😭

she can also parse the ksmbdpwd.db(5) user database so she can give you completions while prompting. thoughtful queen 🫢

and when she's done, she notifies ksmbd.mountd of any changes she made. only if she actually made some, obviously.

also, big one: ksmbd.addshare will only make changes that do not require restarting ksmbd.mountd and ksmbd to take effect. so no dramatic restarts, just vibes. 🌈


πŸ’… OPTIONS πŸ’…

quick note before we dive in: if you don't pass -a, -u, or -d, then she'll either add or update SHARE. and SHARE must be UTF-8 and [1, 64) bytes β€” so at least 1 byte, but strictly less than 64. and SHARE is case-insensitive. no cap. πŸŽ€

  • -a, --add β€” add SHARE to the configuration file. new girl on the block ✨
  • -u, --update β€” update SHARE in the configuration file. glow-up arc πŸ’–
  • -d, --delete β€” delete SHARE from the configuration file. she's gone, we don't talk about her πŸ’€
  • -o, --option=OPT β€” use OPT as the share parameter instead of prompting. you can pass this one multiple times, so stack 'em up πŸ“
  • -C, --config=CONF β€” use CONF as the configuration file instead of /etc/ksmbd/ksmbd.conf. pick your own adventure πŸ¦‹
  • -P, --pwddb=PWDDB β€” use PWDDB as the user database instead of /etc/ksmbd/ksmbdpwd.db. same energy, different file πŸ’œ
  • -v, --verbose β€” be verbose. give us the tea β˜•
  • -V, --version β€” output version information and exit. hi, who are you πŸ‘‹
  • -h, --help β€” display this help and exit. the girlies love a helper 🌸

πŸŽ€ EXIT STATUS πŸŽ€

  • exit status 0 = success πŸ₯³
  • exit status 1 = failure 😭

and lowkey important: failure to notify ksmbd.mountd of changes has no effect on the exit status. so like, she might not have told the daemon, but she's still claiming the 0. main character energy tbh.


Copyright Β© 2015-2022 ksmbd-tools contributors. License GPLv2: GNU GPL version 2 <https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

🫢 translation for the besties: it's free, you can change it, you can share it, but there is literally NO WARRANTY to the extent permitted by law. so don't come for her.

πŸ™ˆ REPORTING BUGS πŸ™ˆ

found a bug? for bug reports, use the issue tracker at <https://github.com/cifsd-team/ksmbd-tools/issues>. tell them everything, they wanna know πŸ’Œ


🌈 SEE ALSO 🌈

Configuration File

User Database

Utilities


and that's the whole page, bestie!! this was ksmbd-tools 3.5.7, and if you scrolled all the way down here β€” you're a real one. go forth and configure your shares. slay. periodt. πŸ’–βœ¨πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from