0x1eef/bsdcontrol.rb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix docs

Browse source
This commit is contained in:
0x1eef 2024-04-09 16:34:12 -03:00
parent 545c060fec
commit 0e03357aa6
2 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -8,12 +8,13 @@ bsdcontrol.rb provides Ruby bindings for libhbsdcontrol from the
__Features__ __Features__
The first example obtains a list of hardenedbsd features that The first example obtains a list of hardenedbsd features that
can be enabled, disabled or restored to the system default: can be enabled, disabled or restored to the system default
setting:
``` ruby ``` ruby
#!/usr/bin/env ruby #!/usr/bin/env ruby
# Required privileges: unprivileged user or superuser. # Required privileges: unprivileged user or superuser.
require "hbsdctl" require "bsdcontrol"
BSD::Control BSD::Control
.available_features .available_features
.each do .each do
@ -31,7 +32,7 @@ over the system default. The system default can be restored with
``` ruby ``` ruby
#!/usr/bin/env ruby #!/usr/bin/env ruby
# Required privileges: superuser. # Required privileges: superuser.
require "hbsdctl" require "bsdcontrol"
BSD::Control BSD::Control
.feature(:mprotect) .feature(:mprotect)
.enable!("/usr/local/bin/emacs-29.2") .enable!("/usr/local/bin/emacs-29.2")
@ -47,7 +48,7 @@ status:
``` ruby ``` ruby
#!/usr/bin/env ruby #!/usr/bin/env ruby
# Required privileges: superuser. # Required privileges: superuser.
require "hbsdctl" require "bsdcontrol"
BSD::Control BSD::Control
.feature(:mprotect) .feature(:mprotect)
.status("/bin/ls") # => :sysdef .status("/bin/ls") # => :sysdef

2
lib/bsd/control/feature.rb
View file

@ -42,7 +42,7 @@ module BSD::Control
## ##
# @!method sysdef!(path) # @!method sysdef!(path)
# Restore system defaults for a given file. # Restores the system default for a given file.
# #
# @param [String] path # @param [String] path
# The path to a file. # The path to a file.