Skip to content

Commit 9822f65

Browse files
committed
Update all API here references to __type__ of their classes
1 parent 1eb9ff5 commit 9822f65

1 file changed

Lines changed: 69 additions & 69 deletions

File tree

docs/source/supported-targets.rst

Lines changed: 69 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -191,43 +191,43 @@ The table below lists the supported container formats.
191191
* - Apple Sparse Image Format
192192
- A sparse disk format introduced by Apple with near native SSD speeds.
193193
- ``.asif``
194-
- :class:`here <dissect.target.containers.asif.AsifContainer>`
194+
- :class:`asif <dissect.target.containers.asif.AsifContainer>`
195195
* - Expert Witness Disk Image Format
196196
- FTK Expert witness data format.
197197
- ``.E01``, ``.L01``, ``.Ex01``, ``.Lx01``
198-
- :class:`here <dissect.target.containers.ewf.EwfContainer>`
198+
- :class:`ewf <dissect.target.containers.ewf.EwfContainer>`
199199
* - Fortinet Firmware
200200
- Interprets and decompresses a Fortinet firmware file.
201201
- ``*-fortinet.out``
202-
- :class:`here <dissect.target.containers.fortifw.FortiFirmwareContainer>`
202+
- :class:`fortifw <dissect.target.containers.fortifw.FortiFirmwareContainer>`
203203
* - HDD
204204
- Parallels HDD virtual disk implementation.
205205
- ``.hdd``
206-
- :class:`here <dissect.target.containers.hdd.HddContainer>`
206+
- :class:`hdd <dissect.target.containers.hdd.HddContainer>`
207207
* - HDS
208208
- Parallels sparse hard disk format
209209
- ``.hds``
210-
- :class:`here <dissect.target.containers.hds.HdsContainer>`
210+
- :class:`hds <dissect.target.containers.hds.HdsContainer>`
211211
* - Qcow2
212212
- QEMU Copy On Write virtual disk format.
213213
- ``.qcow2``
214-
- :class:`here <dissect.target.containers.qcow2.QCow2Container>`
214+
- :class:`qcow2 <dissect.target.containers.qcow2.QCow2Container>`
215215
* - VDI
216216
- The virtualbox harddisk format.
217217
- ``.vdi``
218-
- :class:`here <dissect.target.containers.vdi.VdiContainer>`
218+
- :class:`vdi <dissect.target.containers.vdi.VdiContainer>`
219219
* - Virtual Hard Disk
220220
- The original virtual hard disk format developed by Microsoft. Mainly used by the Hyper-V hypervisor.
221221
- ``.vhd``
222-
- :class:`here <dissect.target.containers.vhd.VhdContainer>`
222+
- :class:`vhd <dissect.target.containers.vhd.VhdContainer>`
223223
* - Virtual Hard Disk X
224224
- Virtual Hard Disk v2, the successor of VHD, and the new default on Hyper-V.
225225
- ``.vhdx``
226-
- :class:`here <dissect.target.containers.vhdx.VhdxContainer>`
226+
- :class:`vhdx <dissect.target.containers.vhdx.VhdxContainer>`
227227
* - VMware disk format
228228
- VMware virtual hard disks.
229229
- ``.vmdk``
230-
- :class:`here <dissect.target.containers.vmdk.VmdkContainer>`
230+
- :class:`vmdk <dissect.target.containers.vmdk.VmdkContainer>`
231231

232232
Partition Schemes and Volume Systems
233233
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -241,13 +241,13 @@ Dissect supports the following partition schemes to divide a disk into multiple
241241
* - Partition Scheme
242242
- API
243243
* - Apple Partition Map
244-
- :class:`here <dissect.volume.disk.schemes.apm.APM>`
244+
- :class:`apm <dissect.volume.disk.schemes.apm.APM>`
245245
* - BSD Disklabel
246-
- :class:`here <dissect.volume.disk.schemes.bsd.BSD>`
246+
- :class:`bsd <dissect.volume.disk.schemes.bsd.BSD>`
247247
* - GUID Partition Table
248-
- :class:`here <dissect.volume.disk.schemes.gpt.GPT>`
248+
- :class:`gpt <dissect.volume.disk.schemes.gpt.GPT>`
249249
* - Master Boot Record
250-
- :class:`here <dissect.volume.disk.schemes.mbr.MBR>`
250+
- :class:`mbr <dissect.volume.disk.schemes.mbr.MBR>`
251251

252252
Besides these standard partition tables used in most computer systems, Dissect supports disks in RAID configurations or disks with logical volumes that span multiple disks.
253253

@@ -267,16 +267,16 @@ The table below lists the different supported volume systems.
267267
* - Disk Data Format
268268
- DDF is a RAID data format that describes how data is formatted across raid groups.
269269
Commonly used by Dell RAID controllers.
270-
- :class:`here <dissect.target.volumes.ddf.DdfVolumeSystem>`
270+
- :class:`ddf <dissect.target.volumes.ddf.DdfVolumeSystem>`
271271
* - Logical Volume Manager 2
272272
- LVM2 is a device mapper framework that can make multiple volumes on a single disk.
273-
- :class:`here <dissect.target.volumes.lvm.LvmVolumeSystem>`
273+
- :class:`lvm2 <dissect.target.volumes.lvm.LvmVolumeSystem>`
274274
* - Multiple Device driver
275275
- Linux MD RAID volume system. A software based RAID system.
276-
- :class:`here <dissect.target.volumes.md.MdVolumeSystem>`
276+
- :class:`md <dissect.target.volumes.md.MdVolumeSystem>`
277277
* - Virtual Machine Filesystem
278278
- VMFS is a clustered filesystem developed by VMWare on an ESXi type hosts.
279-
- :class:`here <dissect.target.volumes.vmfs.VmfsVolumeSystem>`
279+
- :class:`vmfs <dissect.target.volumes.vmfs.VmfsVolumeSystem>`
280280

281281
Dissect also has decryption capability for some well known systems.
282282
This functionality can be accessed with a keychain file (specified with ``-K``) with multiple passphrases or a keychain value (``-Kv``) in most Dissect tools.
@@ -291,10 +291,10 @@ Dissect supports the following encryption formats.
291291
- API
292292
* - Linux Unified Key Setup
293293
- LUKS encrypted volume system. These are the standard specification for disk encryption on linux systems.
294-
- :class:`here <dissect.target.volumes.luks.LUKSVolumeSystem>`
294+
- :class:`luks <dissect.target.volumes.luks.LUKSVolumeSystem>`
295295
* - BitLocker
296296
- BitLocker encrypted volume system. Used by Windows systems
297-
- :class:`here <dissect.target.volumes.bde.BitlockerVolumeSystem>`
297+
- :class:`bde <dissect.target.volumes.bde.BitlockerVolumeSystem>`
298298

299299
Filesystems
300300
~~~~~~~~~~~
@@ -316,58 +316,58 @@ This includes both standard filesystems and formats that resemble filesystem beh
316316
- API
317317
* - AD1
318318
- Forensic container format (AccessData AD1).
319-
- :class:`here <dissect.target.filesystems.ad1.AD1Filesystem>`
319+
- :class:`ad1 <dissect.target.filesystems.ad1.AD1Filesystem>`
320320
* - APFS
321321
- Apple Filesystem.
322-
- :class:`here <dissect.target.filesystems.apfs.ApfsFilesystem>`
322+
- :class:`apfs-container <dissect.target.filesystems.apfs.ApfsFilesystem>`
323323
* - BTRFS
324324
- Binary-tree file system with support for subvolumes.
325-
- :class:`here <dissect.target.filesystems.btrfs.BtrfsFilesystem>`
325+
- :class:`btrfs <dissect.target.filesystems.btrfs.BtrfsFilesystem>`
326326
* - CPIO
327327
- CPIO archive format.
328-
- :class:`here <dissect.target.filesystems.cpio.CpioFilesystem>`
328+
- :class:`cpio <dissect.target.filesystems.cpio.CpioFilesystem>`
329329
* - exFAT
330330
- Microsoft Extensible File Allocation Table filesystem.
331-
- :class:`here <dissect.target.filesystems.exfat.ExfatFilesystem>`
331+
- :class:`exfat <dissect.target.filesystems.exfat.ExfatFilesystem>`
332332
* - Ext2, Ext3, Ext4
333333
- Linux EXT family filesystems.
334-
- :class:`here <dissect.target.filesystems.extfs.ExtFilesystem>`
334+
- :class:`ext <dissect.target.filesystems.extfs.ExtFilesystem>`
335335
* - FAT
336336
- File Allocation Table 12/16/32-bit filesystem.
337-
- :class:`here <dissect.target.filesystems.fat.FatFilesystem>`
337+
- :class:`fat <dissect.target.filesystems.fat.FatFilesystem>`
338338
* - FFS
339339
- Fast Filesystem (BSD).
340-
- :class:`here <dissect.target.filesystems.ffs.FfsFilesystem>`
340+
- :class:`ffs <dissect.target.filesystems.ffs.FfsFilesystem>`
341341
* - JFFS
342342
- Journaling Flash Filesystem.
343-
- :class:`here <dissect.target.filesystems.jffs.JffsFilesystem>`
343+
- :class:`jffs <dissect.target.filesystems.jffs.JffsFilesystem>`
344344
* - NFS
345345
- Network File Share filesystem. Gives the ability to connect to an NFS share
346-
- :class:`here <dissect.target.filesystems.nfs.NfsFilesystem>`
346+
- :class:`nfs <dissect.target.filesystems.nfs.NfsFilesystem>`
347347
* - NTFS
348348
- Microsoft NT Filesystem.
349-
- :class:`here <dissect.target.filesystems.ntfs.NtfsFilesystem>`
349+
- :class:`ntfs <dissect.target.filesystems.ntfs.NtfsFilesystem>`
350350
* - Overlay
351351
- Overlay filesystem combines multiple layers into one singular filesystem. This filesystem is used for container formats for Docker or Podman.
352-
- :class:`here <dissect.target.filesystems.overlay.OverlayFilesystem>`
352+
- :class:`overlay <dissect.target.filesystems.overlay.OverlayFilesystem>`
353353
* - Overlay2
354354
- Overlay2 Filesystem is a more efficient version of the Overlay filesystem.
355-
- :class:`here <dissect.target.filesystems.overlay.Overlay2Filesystem>`
355+
- :class:`overlay2 <dissect.target.filesystems.overlay.Overlay2Filesystem>`
356356
* - QNX4, QNX6
357357
- QNX filesystem, commonly used in the QNX RTOS.
358-
- :class:`here <dissect.target.filesystems.qnxfs.QnxFilesystem>`
358+
- :class:`qnxfs <dissect.target.filesystems.qnxfs.QnxFilesystem>`
359359
* - SquashFS
360360
- Compressed read-only filesystem used by linux systems.
361-
- :class:`here <dissect.target.filesystems.squashfs.SquashFSFilesystem>`
361+
- :class:`squashfs <dissect.target.filesystems.squashfs.SquashFSFilesystem>`
362362
* - Virtual Backup Files
363363
- Filesystem representation of VBK backup files.
364-
- :class:`here <dissect.target.filesystems.vbk.VbkFilesystem>`
364+
- :class:`vbk <dissect.target.filesystems.vbk.VbkFilesystem>`
365365
* - VMFS
366366
- VMware VMFS filesystem.
367-
- :class:`here <dissect.target.filesystems.vmfs.VmfsFilesystem>`
367+
- :class:`vmfs <dissect.target.filesystems.vmfs.VmfsFilesystem>`
368368
* - XFS
369369
- High-performance journaling filesystem
370-
- :class:`here <dissect.target.filesystems.xfs.XfsFilesystem>`
370+
- :class:`xfs <dissect.target.filesystems.xfs.XfsFilesystem>`
371371

372372
Operating Systems
373373
~~~~~~~~~~~~~~~~~
@@ -384,41 +384,41 @@ Below is a list of supported operating systems that Dissect can detect.
384384
* - Operating System
385385
- API
386386
* - Windows
387-
- :class:`here <dissect.target.plugins.os.windows._os.WindowsPlugin>`
387+
- :class:`windows <dissect.target.plugins.os.windows._os.WindowsPlugin>`
388388
* - Unix
389-
- :class:`here <dissect.target.plugins.os.unix._os.UnixPlugin>`
389+
- :class:`unix <dissect.target.plugins.os.unix._os.UnixPlugin>`
390390
* - ESXi
391-
- :class:`here <dissect.target.plugins.os.unix.esxi._os.ESXiPlugin>`
391+
- :class:`esxi <dissect.target.plugins.os.unix.esxi._os.ESXiPlugin>`
392392
* - BSD
393-
- :class:`here <dissect.target.plugins.os.unix.bsd._os.BsdPlugin>`
393+
- :class:`bsd <dissect.target.plugins.os.unix.bsd._os.BsdPlugin>`
394394
* - Citrix
395-
- :class:`here <dissect.target.plugins.os.unix.bsd.citrix._os.CitrixPlugin>`
395+
- :class:`citrix <dissect.target.plugins.os.unix.bsd.citrix._os.CitrixPlugin>`
396396
* - FreeBSD
397-
- :class:`here <dissect.target.plugins.os.unix.bsd.freebsd._os.FreeBsdPlugin>`
397+
- :class:`freebsd <dissect.target.plugins.os.unix.bsd.freebsd._os.FreeBsdPlugin>`
398398
* - OpenBSD
399-
- :class:`here <dissect.target.plugins.os.unix.bsd.openbsd._os.OpenBsdPlugin>`
399+
- :class:`openbsd <dissect.target.plugins.os.unix.bsd.openbsd._os.OpenBsdPlugin>`
400400
* - Darwin
401-
- :class:`here <dissect.target.plugins.os.unix.bsd.darwin._os.DarwinPlugin>`
401+
- :class:`darwin <dissect.target.plugins.os.unix.bsd.darwin._os.DarwinPlugin>`
402402
* - iOS
403-
- :class:`here <dissect.target.plugins.os.unix.bsd.darwin.ios._os.IOSPlugin>`
403+
- :class:`ios <dissect.target.plugins.os.unix.bsd.darwin.ios._os.IOSPlugin>`
404404
* - macOS
405-
- :class:`here <dissect.target.plugins.os.unix.bsd.darwin.macos._os.MacOSPlugin>`
405+
- :class:`macos <dissect.target.plugins.os.unix.bsd.darwin.macos._os.MacOSPlugin>`
406406
* - Generic Linux
407-
- :class:`here <dissect.target.plugins.os.unix.linux._os.LinuxPlugin>`
407+
- :class:`linux <dissect.target.plugins.os.unix.linux._os.LinuxPlugin>`
408408
* - Android
409-
- :class:`here <dissect.target.plugins.os.unix.linux.android._os.AndroidPlugin>`
409+
- :class:`android <dissect.target.plugins.os.unix.linux.android._os.AndroidPlugin>`
410410
* - FortiOS
411-
- :class:`here <dissect.target.plugins.os.unix.linux.fortios._os.FortiOSPlugin>`
411+
- :class:`fortios <dissect.target.plugins.os.unix.linux.fortios._os.FortiOSPlugin>`
412412
* - OpenSUSE
413-
- :class:`here <dissect.target.plugins.os.unix.linux.suse._os.SuSEPlugin>`
413+
- :class:`opensuse <dissect.target.plugins.os.unix.linux.suse._os.SuSEPlugin>`
414414
* - RedHat
415-
- :class:`here <dissect.target.plugins.os.unix.linux.redhat._os.RedHatPlugin>`
415+
- :class:`redhat <dissect.target.plugins.os.unix.linux.redhat._os.RedHatPlugin>`
416416
* - Debian
417-
- :class:`here <dissect.target.plugins.os.unix.linux.debian._os.DebianPlugin>`
417+
- :class:`debian <dissect.target.plugins.os.unix.linux.debian._os.DebianPlugin>`
418418
* - Proxmox
419-
- :class:`here <dissect.target.plugins.os.unix.linux.debian.proxmox._os.ProxmoxPlugin>`
419+
- :class:`proxmox <dissect.target.plugins.os.unix.linux.debian.proxmox._os.ProxmoxPlugin>`
420420
* - VyOS
421-
- :class:`here <dissect.target.plugins.os.unix.linux.debian.vyos._os.VyosPlugin>`
421+
- :class:`vyos <dissect.target.plugins.os.unix.linux.debian.vyos._os.VyosPlugin>`
422422

423423
Child Targets
424424
~~~~~~~~~~~~~
@@ -441,41 +441,41 @@ It can even look deeper, and look inside those systems within systems for even m
441441
- API
442442
* - Colima
443443
- Colima container format, which is a runtime for both Linux and macOS.
444-
- :class:`here <dissect.target.plugins.child.colima.ColimaChildTargetPlugin>`
444+
- :class:`colima <dissect.target.plugins.child.colima.ColimaChildTargetPlugin>`
445445
* - Docker
446446
- The Docker overlay2fs containers that are available on the system.
447-
- :class:`here <dissect.target.plugins.child.docker.DockerChildTargetPlugin>`
447+
- :class:`docker <dissect.target.plugins.child.docker.DockerChildTargetPlugin>`
448448
* - ESXi
449449
- The VM inventory on ESXi machines.
450-
- :class:`here <dissect.target.plugins.child.esxi.ESXiChildTargetPlugin>`
450+
- :class:`esxi <dissect.target.plugins.child.esxi.ESXiChildTargetPlugin>`
451451
* - Hyper-V
452452
- The VM inventory on Hyper-V Windows hosts.
453-
- :class:`here <dissect.target.plugins.child.hyperv.HyperVChildTargetPlugin>`
453+
- :class:`hyper-v <dissect.target.plugins.child.hyperv.HyperVChildTargetPlugin>`
454454
* - Lima
455455
- Lima, Linux Machines, is a container / VM runtime that supports different container engines such as Docker, Podman, and Kubernetes.
456-
- :class:`here <dissect.target.plugins.child.lima.LimaChildTargetPlugin>`
456+
- :class:`lima <dissect.target.plugins.child.lima.LimaChildTargetPlugin>`
457457
* - Parallels
458458
- The Parallels Desktop inventory, Parallels is a hypervisor for Mac computers.
459-
- :class:`here <dissect.target.plugins.child.parallels.ParallelsChildTargetPlugin>`
459+
- :class:`parallels <dissect.target.plugins.child.parallels.ParallelsChildTargetPlugin>`
460460
* - Podman
461461
- Podman, a container runtime engine such as Docker.
462-
- :class:`here <dissect.target.plugins.child.podman.PodmanChildTargetPlugin>`
462+
- :class:`podman <dissect.target.plugins.child.podman.PodmanChildTargetPlugin>`
463463
* - Proxmox
464464
- Proxmox is a debian based virtualization platform.
465-
- :class:`here <dissect.target.plugins.child.proxmox.ProxmoxChildTargetPlugin>`
465+
- :class:`proxmox <dissect.target.plugins.child.proxmox.ProxmoxChildTargetPlugin>`
466466
* - QEMU
467467
- All QEMU virtual machines created by the KVM libvirt deamon.
468-
- :class:`here <dissect.target.plugins.child.qemu.QemuChildTargetPlugin>`
468+
- :class:`qemu <dissect.target.plugins.child.qemu.QemuChildTargetPlugin>`
469469
* - VirtualBox
470470
- Oracle VirtualBox VMs.
471-
- :class:`here <dissect.target.plugins.child.virtualbox.VirtualBoxChildTargetPlugin>`
471+
- :class:`virtualbox <dissect.target.plugins.child.virtualbox.VirtualBoxChildTargetPlugin>`
472472
* - Virtuozzo
473473
- All the Virtuozzo containers.
474-
- :class:`here <dissect.target.plugins.child.virtuozzo.VirtuozzoChildTargetPlugin>`
474+
- :class:`virtuozzo <dissect.target.plugins.child.virtuozzo.VirtuozzoChildTargetPlugin>`
475475
* - VMware Workstation
476476
- All the VMs registerd within the VMware Workstation VM inventory.
477-
- :class:`here <dissect.target.plugins.child.vmware_workstation.VmwareWorkstationChildTargetPlugin>`
477+
- :class:`vmware <dissect.target.plugins.child.vmware_workstation.VmwareWorkstationChildTargetPlugin>`
478478
* - WSL2
479479
- All the Windows Subsystem for Linux 2 instances.
480-
- :class:`here <dissect.target.plugins.child.wsl.WSLChildTargetPlugin>`
480+
- :class:`wsl <dissect.target.plugins.child.wsl.WSLChildTargetPlugin>`
481481

0 commit comments

Comments
 (0)