KSMBD.ADDUSER(8)

πŸ’– KSMBD.ADDUSER β€” the manual, but make it cute πŸ’–

okay so bestie, you're reading KSMBD.ADDUSER(8), a System Administration page, and honestly? it's giving "I manage users for a living and I'm thriving." let's get into it πŸŽ€


✨ NAME ✨

ksmbd.adduser β€” configure users for ksmbdpwd.db of ksmbd.mountd

like that's literally the whole job. user management. slay. πŸ’…


🌸 SYNOPSIS 🌸

ksmbd.adduser [-v] [-P PWDDB] [-C CONF] [-a | -u | -d] [-p PWD] USER

look at her. so structured. so iconic. ✨


πŸ¦‹ DESCRIPTION πŸ¦‹

okay so ksmbd.adduser configures users for the ksmbdpwd.db(5) user database that belongs to the ksmbd.mountd(8) user mode daemon. that's the whole vibe 🫢

here's the smart part, no cap: ksmbd.adduser can parse the ksmbd.conf(5) configuration file so it can guard against deletion of users that are depended on. meaning it's not gonna let you delete somebody the config still needs. protective king behavior fr fr πŸ‘‘

and when it actually makes changes, ksmbd.adduser notifies ksmbd.mountd about them. communication! healthy relationship! we love to see it πŸ’–


πŸ’… OPTIONS πŸ’…

okay so first things first, if you don't give it neither -a, -u, nor -d β€” like none of them at all β€” it'll either add or update USER. dealer's choice, she decides. 😌

and some rules about USER, because there are always rules:

  • USER must be UTF-8 and [1, 48) bytes. yes that's a half-open interval bestie, the 48 is NOT included. πŸ’€
  • USER cannot contain a colon (:). just don't.

now the actual flags, one by one, no skipping:

  • -a, --add β€” add USER to the user database. new friend acquired ✨
  • -u, --update β€” update USER in the user database. glow-up time πŸ’…
  • -d, --delete β€” delete USER from the user database. we don't talk about them anymore 🚫
  • -p, --password=PWD β€” use PWD as the user password instead of prompting. PWD must be UTF-8 and [0, 129) bytes β€” yeah, 129 not included, and yes it can be zero bytes, that's a whole thing πŸ™ˆ
  • -P, --pwddb=PWDDB β€” use PWDDB as the user database instead of /etc/ksmbd/ksmbdpwd.db. custom location, main character energy πŸ‘‘
  • -C, --config=CONF β€” use CONF as the configuration file instead of /etc/ksmbd/ksmbd.conf. yep, another path swap πŸ¦‹
  • -v, --verbose β€” be verbose. she will yap (affectionately) πŸ—£οΈ
  • -V, --version β€” output version information and exit. bye! πŸ‘‹
  • -h, --help β€” display this help and exit. also bye! πŸ‘‹

πŸ”₯ EXIT STATUS πŸ”₯

the exit status is 0 on success and 1 on failure. simple. binary. she doesn't do nuance ✨

and here's the lowkey important bit: failure to notify ksmbd.mountd of changes has no effect on exit status. so like, if the notifying part flops, the exit status does not care. it's unbothered. πŸ’…


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.

(read that last one again bestie, NO WARRANTY, capital letters, they meant it 😭)


πŸ› REPORTING BUGS πŸ›

found a bug? for bug reports, use the issue tracker at <https://github.com/cifsd-team/ksmbd-tools/issues>.

go tell them, they wanna know, fr fr 🫢


🌈 SEE ALSO 🌈

User Database

Configuration File

Utilities


and that's the whole page bestie!! this was ksmbd-tools 3.5.7, manual page KSMBD.ADDUSER(8), and yes the date and version live down here at the bottom like a little signature. go add some users, you're gonna ate πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from